TRANSIT API (1.0.0)

Download OpenAPI specification:Download

This is the Transit API documentation.

imprint: https://www.uni-leipzig.de/impressum

privacy policy: https://www.uni-leipzig.de/datenschutz

contact: https://transit-project.de/kontakt/

user-user-property-controller

readOne

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

userId required	string <uuid>
userPropertyId required	string <uuid>

Responses

update

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

userId required	string <uuid>
userPropertyId required	string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

userId required	string <uuid>
userPropertyId required	string <uuid>

Responses

partialUpdate

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

userId required	string <uuid>
userPropertyId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_1

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

userId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_1

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

userId

required

string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

user-controller

readOne_1

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

id

required

string <uuid>

Responses

update_1

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
companyId	string <uuid>
keycloakId required	string <uuid>
firstName	string
lastName	string
email	string
enabled	boolean
realmRoles	Array of strings
groups	Array of strings
jobPosition	string
	object (Links)
	Array of objects (UserPropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"keycloakId": "986e9f28-bd56-4af7-b160-5e7df599f68e",
"firstName": "string",
"lastName": "string",
"email": "string",
"enabled": true,
"realmRoles": ["string"
],
"groups": ["string"
],
"jobPosition": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"userProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

delete_1

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_1

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false;userProperties.deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
companyId	string <uuid>
keycloakId required	string <uuid>
firstName	string
lastName	string
email	string
enabled	boolean
realmRoles	Array of strings
groups	Array of strings
jobPosition	string
	object (Links)
	Array of objects (UserPropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"keycloakId": "986e9f28-bd56-4af7-b160-5e7df599f68e",
"firstName": "string",
"lastName": "string",
"email": "string",
"enabled": true,
"realmRoles": ["string"
],
"groups": ["string"
],
"jobPosition": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"userProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

register

This api endpoint requires **** permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
keycloakId required	string <uuid>
realmRoles required	Array of strings
groups	Array of strings
jobPosition	string
required	object (CompanyDTORegistration)
enabled	boolean
	object (Links)
	Array of objects (UserPropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"keycloakId": "986e9f28-bd56-4af7-b160-5e7df599f68e",
"realmRoles": ["string"
],
"groups": ["string"
],
"jobPosition": "string",
"company": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"companyAddresses": [{"addressType": "string",
"locationPoint": {"envelope": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"street": "string",
"zip": "string",
"city": "string",
"state": "string",
"country": "string",
"isoCode": "string",
"addressExtra": "string",
"companyName": "string",
"clientName": "string"
}
],
"name": "string",
"companyProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"enabled": true,
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"userProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

getUserDTOFromAuthenticatedUser

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

keycloakId

required

string <uuid>

Responses

getUserIdFromAuthenticatedUser

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

keycloakId

required

string <uuid>

Responses

user-property-controller

readOne_2

This api endpoint requires **** permission.

path Parameters

id

required

string <uuid>

Responses

update_2

This api endpoint requires **** permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_2

This api endpoint requires **** permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_2

This api endpoint requires **** permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

package-property-controller

readOne_3

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

update_3

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
defaultValue	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"defaultValue": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_3

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_3

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_2

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_2

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
defaultValue	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"defaultValue": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

package-package-property-controller

readOne_4

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

id

required

string <uuid>

Responses

update_4

This api endpoint requires CREATOR_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_4

This api endpoint requires **** permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_4

This api endpoint requires CREATOR_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

package-item-package-package-property-controller

readOne_5

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

packageItemId required	string <uuid>
packagePropertyId required	string <uuid>

Responses

update_5

This api endpoint requires CREATOR_ORDER permission.

path Parameters

packageItemId required	string <uuid>
packagePropertyId required	string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_5

This api endpoint requires **** permission.

path Parameters

packageItemId required	string <uuid>
packagePropertyId required	string <uuid>

Responses

partialUpdate_5

This api endpoint requires CREATOR_ORDER permission.

path Parameters

packageItemId required	string <uuid>
packagePropertyId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_4

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

packageItemId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_4

This api endpoint requires CREATOR_ORDER, SUPPLIER permission.

path Parameters

packageItemId

required

string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

package-item-controller

readOne_7

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

id

required

string <uuid>

Responses

update_6

This api endpoint requires CREATOR_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
required	object (PackagePackageClassDTO)
weightKg	number <double>
heightCm	number <double>
widthCm	number <double>
deepCm	number <double>
frost	boolean
explosive	boolean
comment	string
packagePrice	number <double>
	object (Links)
	Array of objects (PackagePackagePropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"packageClass": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"weightKg": 0.1,
"heightCm": 0.1,
"widthCm": 0.1,
"deepCm": 0.1,
"frost": true,
"explosive": true,
"comment": "string",
"packagePrice": 0.1,
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"packagePackageProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

delete_6

This api endpoint requires CREATOR_ORDER permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_6

This api endpoint requires CREATOR_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_3

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false;packagePackageProperties.deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_3

This api endpoint requires CREATOR_ORDER permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
required	object (PackagePackageClassDTO)
weightKg	number <double>
heightCm	number <double>
widthCm	number <double>
deepCm	number <double>
frost	boolean
explosive	boolean
comment	string
packagePrice	number <double>
	object (Links)
	Array of objects (PackagePackagePropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"packageClass": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"weightKg": 0.1,
"heightCm": 0.1,
"widthCm": 0.1,
"deepCm": 0.1,
"frost": true,
"explosive": true,
"comment": "string",
"packagePrice": 0.1,
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"packagePackageProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

package-class-controller

readOne_8

This api endpoint requires ADMIN_GLOBAL, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

id

required

string <uuid>

Responses

update_7

This api endpoint requires ADMIN_GLOBAL permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_7

This api endpoint requires **** permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_7

This api endpoint requires ADMIN_GLOBAL permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_5

This api endpoint requires ADMIN_GLOBAL, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_5

This api endpoint requires ADMIN_GLOBAL permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

order-suborder-controller

readOne_9

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId required	string <uuid>
suborderId required	string <uuid>

Responses

update_8

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId required	string <uuid>
suborderId required	string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
shortId	string <uuid>
	object (IdentifierDTO)
destinationDate	string <date-time>
pickUpDate	string <date-time>
required	object (IdentifierDTO)
required	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
orderStatus	string
	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
attentionFlag	boolean
suborderType	boolean
internalComment	string
price	number <double>
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
packagesPrice	number <double>
deliveryPerson	string
outsourceCost	number <double>
orderAltPrice	number <double>
reasonForCancel	string
oldOrderId	string <uuid>
newOrderId	string <uuid>
	object (IdentifierDTO)
pickUpDateTo	string <date-time>
destinationDateTo	string <date-time>
pickUpPerson	string
hasNotableSuborderStatus	boolean
notableSuborderStatus	string
pickUpTimestampLeave	string <date-time>
pickUpTimestampArrive	string <date-time>
deliveryTimestampLeave	string <date-time>
deliveryTimestampArrive	string <date-time>
	object (Links)
	Array of objects (OrderPropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"shortId": "831ec859-e7d4-46bd-8056-29bc608dc007",
"parentOrderId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"destinationDate": "2019-08-24T14:15:22Z",
"pickUpDate": "2019-08-24T14:15:22Z",
"addressIdFrom": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdTo": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdBilling": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"suborderIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderTypeIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"companyId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"orderRouteIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderStatus": "string",
"paymentId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"costId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"packageItemIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"deliveryMethodId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"attentionFlag": true,
"suborderType": true,
"internalComment": "string",
"price": 0.1,
"contactPersonId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"parentOrderInformationIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"packagesPrice": 0.1,
"deliveryPerson": "string",
"outsourceCost": 0.1,
"orderAltPrice": 0.1,
"reasonForCancel": "string",
"oldOrderId": "ea8dbc59-ee8c-4719-bcb5-cacb8bb811fe",
"newOrderId": "daca5f63-d3e4-4268-8fc7-67b0e1613046",
"customerId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"pickUpDateTo": "2019-08-24T14:15:22Z",
"destinationDateTo": "2019-08-24T14:15:22Z",
"pickUpPerson": "string",
"hasNotableSuborderStatus": true,
"notableSuborderStatus": "string",
"pickUpTimestampLeave": "2019-08-24T14:15:22Z",
"pickUpTimestampArrive": "2019-08-24T14:15:22Z",
"deliveryTimestampLeave": "2019-08-24T14:15:22Z",
"deliveryTimestampArrive": "2019-08-24T14:15:22Z",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"orderProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

delete_8

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId required	string <uuid>
suborderId required	string <uuid>

Responses

partialUpdate_8

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId required	string <uuid>
suborderId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_7

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false;orderProperties.deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_7

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
shortId	string <uuid>
	object (IdentifierDTO)
destinationDate	string <date-time>
pickUpDate	string <date-time>
required	object (IdentifierDTO)
required	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
orderStatus	string
	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
attentionFlag	boolean
suborderType	boolean
internalComment	string
price	number <double>
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
packagesPrice	number <double>
deliveryPerson	string
outsourceCost	number <double>
orderAltPrice	number <double>
reasonForCancel	string
oldOrderId	string <uuid>
newOrderId	string <uuid>
	object (IdentifierDTO)
pickUpDateTo	string <date-time>
destinationDateTo	string <date-time>
pickUpPerson	string
hasNotableSuborderStatus	boolean
notableSuborderStatus	string
pickUpTimestampLeave	string <date-time>
pickUpTimestampArrive	string <date-time>
deliveryTimestampLeave	string <date-time>
deliveryTimestampArrive	string <date-time>
	object (Links)
	Array of objects (OrderPropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"shortId": "831ec859-e7d4-46bd-8056-29bc608dc007",
"parentOrderId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"destinationDate": "2019-08-24T14:15:22Z",
"pickUpDate": "2019-08-24T14:15:22Z",
"addressIdFrom": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdTo": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdBilling": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"suborderIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderTypeIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"companyId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"orderRouteIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderStatus": "string",
"paymentId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"costId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"packageItemIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"deliveryMethodId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"attentionFlag": true,
"suborderType": true,
"internalComment": "string",
"price": 0.1,
"contactPersonId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"parentOrderInformationIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"packagesPrice": 0.1,
"deliveryPerson": "string",
"outsourceCost": 0.1,
"orderAltPrice": 0.1,
"reasonForCancel": "string",
"oldOrderId": "ea8dbc59-ee8c-4719-bcb5-cacb8bb811fe",
"newOrderId": "daca5f63-d3e4-4268-8fc7-67b0e1613046",
"customerId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"pickUpDateTo": "2019-08-24T14:15:22Z",
"destinationDateTo": "2019-08-24T14:15:22Z",
"pickUpPerson": "string",
"hasNotableSuborderStatus": true,
"notableSuborderStatus": "string",
"pickUpTimestampLeave": "2019-08-24T14:15:22Z",
"pickUpTimestampArrive": "2019-08-24T14:15:22Z",
"deliveryTimestampLeave": "2019-08-24T14:15:22Z",
"deliveryTimestampArrive": "2019-08-24T14:15:22Z",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"orderProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

order-order-property-controller

readOne_10

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId required	string <uuid>
orderPropertyId required	string <uuid>

Responses

update_9

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId required	string <uuid>
orderPropertyId required	string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_9

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId required	string <uuid>
orderPropertyId required	string <uuid>

Responses

partialUpdate_9

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId required	string <uuid>
orderPropertyId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_8

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_8

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId

required

string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

order-comment-chat-controller

update_10

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId required	string <uuid>
id required	string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
comment	string
companyId	string <uuid>
orderId	string <uuid>
postParent	boolean
postChild	boolean
person	string Enum: "ME" "YOU"
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"comment": "string",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"postParent": true,
"postChild": true,
"person": "ME",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_10

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId required	string <uuid>
id required	string <uuid>

Responses

patch

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId required	string <uuid>
id required	string <uuid>

Request Body schema: application/json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/json

{ }

read_9

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId

required

string <uuid>

Responses

create_9

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

orderId

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
comment	string
companyId	string <uuid>
orderId	string <uuid>
postParent	boolean
postChild	boolean
person	string Enum: "ME" "YOU"
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"comment": "string",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"postParent": true,
"postChild": true,
"person": "ME",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

order-controller

readOne_11

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

update_11

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
shortId	string <uuid>
	object (IdentifierDTO)
destinationDate	string <date-time>
pickUpDate	string <date-time>
required	object (IdentifierDTO)
required	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
orderStatus	string
	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
attentionFlag	boolean
suborderType	boolean
internalComment	string
price	number <double>
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
packagesPrice	number <double>
deliveryPerson	string
outsourceCost	number <double>
orderAltPrice	number <double>
reasonForCancel	string
oldOrderId	string <uuid>
newOrderId	string <uuid>
	object (IdentifierDTO)
pickUpDateTo	string <date-time>
destinationDateTo	string <date-time>
pickUpPerson	string
hasNotableSuborderStatus	boolean
notableSuborderStatus	string
pickUpTimestampLeave	string <date-time>
pickUpTimestampArrive	string <date-time>
deliveryTimestampLeave	string <date-time>
deliveryTimestampArrive	string <date-time>
	object (Links)
	Array of objects (OrderPropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"shortId": "831ec859-e7d4-46bd-8056-29bc608dc007",
"parentOrderId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"destinationDate": "2019-08-24T14:15:22Z",
"pickUpDate": "2019-08-24T14:15:22Z",
"addressIdFrom": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdTo": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdBilling": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"suborderIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderTypeIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"companyId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"orderRouteIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderStatus": "string",
"paymentId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"costId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"packageItemIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"deliveryMethodId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"attentionFlag": true,
"suborderType": true,
"internalComment": "string",
"price": 0.1,
"contactPersonId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"parentOrderInformationIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"packagesPrice": 0.1,
"deliveryPerson": "string",
"outsourceCost": 0.1,
"orderAltPrice": 0.1,
"reasonForCancel": "string",
"oldOrderId": "ea8dbc59-ee8c-4719-bcb5-cacb8bb811fe",
"newOrderId": "daca5f63-d3e4-4268-8fc7-67b0e1613046",
"customerId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"pickUpDateTo": "2019-08-24T14:15:22Z",
"destinationDateTo": "2019-08-24T14:15:22Z",
"pickUpPerson": "string",
"hasNotableSuborderStatus": true,
"notableSuborderStatus": "string",
"pickUpTimestampLeave": "2019-08-24T14:15:22Z",
"pickUpTimestampArrive": "2019-08-24T14:15:22Z",
"deliveryTimestampLeave": "2019-08-24T14:15:22Z",
"deliveryTimestampArrive": "2019-08-24T14:15:22Z",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"orderProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

delete_11

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_10

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

resetoutsource

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

Array of objects (SharingDefaultDTO)

Responses

Request samples

Payload

Content type

application/json

{"defaultSharingRights": [{"entity": "string",
"companyProperties": [{"property": "string",
"read": true,
"write": true
}
]
}
]
}

read_6

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false;orderProperties.deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_6

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
shortId	string <uuid>
	object (IdentifierDTO)
destinationDate	string <date-time>
pickUpDate	string <date-time>
required	object (IdentifierDTO)
required	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
	Array of objects (IdentifierDTO)
orderStatus	string
	object (IdentifierDTO)
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
	object (IdentifierDTO)
attentionFlag	boolean
suborderType	boolean
internalComment	string
price	number <double>
	object (IdentifierDTO)
	Array of objects (IdentifierDTO) unique
packagesPrice	number <double>
deliveryPerson	string
outsourceCost	number <double>
orderAltPrice	number <double>
reasonForCancel	string
oldOrderId	string <uuid>
newOrderId	string <uuid>
	object (IdentifierDTO)
pickUpDateTo	string <date-time>
destinationDateTo	string <date-time>
pickUpPerson	string
hasNotableSuborderStatus	boolean
notableSuborderStatus	string
pickUpTimestampLeave	string <date-time>
pickUpTimestampArrive	string <date-time>
deliveryTimestampLeave	string <date-time>
deliveryTimestampArrive	string <date-time>
	object (Links)
	Array of objects (OrderPropertyDTO) unique

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"shortId": "831ec859-e7d4-46bd-8056-29bc608dc007",
"parentOrderId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"destinationDate": "2019-08-24T14:15:22Z",
"pickUpDate": "2019-08-24T14:15:22Z",
"addressIdFrom": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdTo": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"addressIdBilling": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"suborderIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderTypeIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"companyId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"orderRouteIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"orderStatus": "string",
"paymentId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"costId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"packageItemIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"deliveryMethodId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"attentionFlag": true,
"suborderType": true,
"internalComment": "string",
"price": 0.1,
"contactPersonId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"parentOrderInformationIds": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"packagesPrice": 0.1,
"deliveryPerson": "string",
"outsourceCost": 0.1,
"orderAltPrice": 0.1,
"reasonForCancel": "string",
"oldOrderId": "ea8dbc59-ee8c-4719-bcb5-cacb8bb811fe",
"newOrderId": "daca5f63-d3e4-4268-8fc7-67b0e1613046",
"customerId": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
},
"pickUpDateTo": "2019-08-24T14:15:22Z",
"destinationDateTo": "2019-08-24T14:15:22Z",
"pickUpPerson": "string",
"hasNotableSuborderStatus": true,
"notableSuborderStatus": "string",
"pickUpTimestampLeave": "2019-08-24T14:15:22Z",
"pickUpTimestampArrive": "2019-08-24T14:15:22Z",
"deliveryTimestampLeave": "2019-08-24T14:15:22Z",
"deliveryTimestampArrive": "2019-08-24T14:15:22Z",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"orderProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
]
}

readOrderStatus

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Responses

updateOrderStatus

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

orderStatus required	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"orderStatus": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

copyOrder

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

readOnePart

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

readOneFull

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

readFull

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false;orderProperties.deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

global-company-properties-controller

readOne_12

This api is public

path Parameters

id

required

string <uuid>

Responses

update_12

This api endpoint requires ADMIN_GLOBAL permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_12

This api endpoint requires **** permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_11

This api endpoint requires ADMIN_GLOBAL permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_12

This api is public

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_11

This api endpoint requires ADMIN_GLOBAL permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

rights-controller

readOne_13

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

query Parameters

companyid

required

string <uuid>

Responses

update_13

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

Array of objects (RightsDtoCore)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"properties": {"readProperties": ["string"
],
"writeProperties": ["string"
]
}
}
]
}

partialUpdate_12

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

createFast

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

Request Body schema: application/json
required

Array of objects (RightsDtoCore)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"properties": {"readProperties": ["string"
],
"writeProperties": ["string"
]
}
}
]
}

updateRightsByOrderAssigment

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id required	string <uuid>
idSub required	string <uuid>

Request Body schema: application/json
required

Array of objects (RightsDtoCore)

Responses

Request samples

Payload

Content type

application/json

{"entries": [{"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"properties": {"readProperties": ["string"
],
"writeProperties": ["string"
]
}
}
]
}

contact-person-controller

readOne_14

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

update_14

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
email	string
phone	string
companyId	string <uuid>
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"email": "string",
"phone": "string",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_13

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_13

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_13

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_12

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
email	string
phone	string
companyId	string <uuid>
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"email": "string",
"phone": "string",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

company-property-controller

readOne_15

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

id

required

string <uuid>

Responses

update_15

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_14

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_14

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

company-controller

readOne_16

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

update_16

This api endpoint requires OWNER_COMPANY permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
	Array of objects (CompanyPropertyDTO) unique
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"companyProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_15

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_15

This api endpoint requires OWNER_COMPANY permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_14

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false;companyProperties.deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_13

This api endpoint requires **** permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
	Array of objects (CompanyPropertyDTO) unique
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"companyProperties": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}
],
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

getDefaultSharingRights

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Responses

setDefaultSharingRights

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

defaultSharingRights

required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/json

{"defaultSharingRights": { }
}

read_Full

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false;companyProperties.deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

company-favorite-controller

readOne_17

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId required	string <uuid>
companyFavoriteId required	string <uuid>

Responses

update_17

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyFavoriteId required	string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
companyIds	Array of strings <uuid> unique [ items <uuid > ]
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"companyIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_16

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyFavoriteId required	string <uuid>

Responses

partialUpdate_16

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyFavoriteId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_15

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_14

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
companyIds	Array of strings <uuid> unique [ items <uuid > ]
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"companyIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

readName

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId

required

string <uuid>

Responses

company-delivery-area-controller

readOne_18

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId required	string <uuid>
companyDeliveryAreaId required	string <uuid>

Responses

update_18

This api endpoint requires OWNER_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyDeliveryAreaId required	string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
deliveryAreaZips required	Array of strings
deliveryAreaPolyline	string
	object (Geometry)
	object (Links)
companyId	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"deliveryAreaZips": ["string"
],
"deliveryAreaPolyline": "string",
"deliveryAreaGeom": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": { },
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": { },
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda"
}

delete_17

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyDeliveryAreaId required	string <uuid>

Responses

partialUpdate_17

This api endpoint requires OWNER_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyDeliveryAreaId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_16

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_15

This api endpoint requires OWNER_COMPANY permission.

path Parameters

companyId

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
deliveryAreaZips required	Array of strings
deliveryAreaPolyline	string
	object (Geometry)
	object (Links)
companyId	string <uuid>

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"deliveryAreaZips": ["string"
],
"deliveryAreaPolyline": "string",
"deliveryAreaGeom": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": { },
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": { },
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
},
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda"
}

company-customer-controller

readOne_19

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId required	string <uuid>
customerId required	string <uuid>

Responses

update_19

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
customerId required	string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
email	string
tel	string
companyId	string <uuid>
addressId	string <uuid>
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"email": "string",
"tel": "string",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_18

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
customerId required	string <uuid>

Responses

partialUpdate_18

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
customerId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_17

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_16

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
name	string
email	string
tel	string
companyId	string <uuid>
addressId	string <uuid>
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"name": "string",
"email": "string",
"tel": "string",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"addressId": "785d1fc4-8ab5-48f1-8685-117cac9865d6",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

company-company-property-controller

readOne_20

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyPropertyId required	string <uuid>

Responses

update_20

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyPropertyId required	string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_19

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyPropertyId required	string <uuid>

Responses

partialUpdate_19

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyPropertyId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_18

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_17

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId

required

string <uuid>

Request Body schema: application/json
required

id	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
key	string
value	string
type	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"key": "string",
"value": "string",
"type": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

company-company-address-controller

readOne_21

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId required	string <uuid>
companyAddressId required	string <uuid>

Responses

update_21

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyAddressId required	string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
companyId	string <uuid>
addressType required	string
required	object (Point)
street	string
zip required	string
city required	string
state	string
country required	string
isoCode required	string
addressExtra	string
companyName	string
clientName	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"addressType": "string",
"locationPoint": {"envelope": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"street": "string",
"zip": "string",
"city": "string",
"state": "string",
"country": "string",
"isoCode": "string",
"addressExtra": "string",
"companyName": "string",
"clientName": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_20

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyAddressId required	string <uuid>

Responses

partialUpdate_20

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId required	string <uuid>
companyAddressId required	string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_19

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

companyId

required

string <uuid>

query Parameters

filter	string Default: "deleted==false"
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""
createdByMyCompany	boolean Default: false

Responses

create_18

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY permission.

path Parameters

companyId

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
companyId	string <uuid>
addressType required	string
required	object (Point)
street	string
zip required	string
city required	string
state	string
country required	string
isoCode required	string
addressExtra	string
companyName	string
clientName	string
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"addressType": "string",
"locationPoint": {"envelope": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"street": "string",
"zip": "string",
"city": "string",
"state": "string",
"country": "string",
"isoCode": "string",
"addressExtra": "string",
"companyName": "string",
"clientName": "string",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

address-controller

readOne_22

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

id

required

string <uuid>

Responses

update_22

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
required	object (Point)
street	string
zip required	string
city required	string
state	string
country required	string
isoCode required	string
addressExtra	string
companyName	string
clientName	string
phoneNumber	string
inOrderUsed	boolean
companyAddress	boolean
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"locationPoint": {"envelope": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"street": "string",
"zip": "string",
"city": "string",
"state": "string",
"country": "string",
"isoCode": "string",
"addressExtra": "string",
"companyName": "string",
"clientName": "string",
"phoneNumber": "string",
"inOrderUsed": true,
"companyAddress": true,
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

delete_21

This api endpoint requires ADMIN_GLOBAL, OWNER_COMPANY permission.

path Parameters

id

required

string <uuid>

Responses

partialUpdate_21

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

path Parameters

id

required

string <uuid>

Request Body schema: application/merge-patch+json
required

object (JsonNode)

Responses

Request samples

Payload

Content type

application/merge-patch+json

{ }

read_20

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required	object (Pageable)
filter	string Default: "deleted==false"
createdByMyCompany	boolean Default: false
skip	integer <int32> Default: -1
take	integer <int32> Default: 0
extraFilterParameters	string Default: ""

Responses

create_19

This api endpoint requires OWNER_COMPANY, ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
required	object (Point)
street	string
zip required	string
city required	string
state	string
country required	string
isoCode required	string
addressExtra	string
companyName	string
clientName	string
phoneNumber	string
inOrderUsed	boolean
companyAddress	boolean
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"locationPoint": {"envelope": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"x": 0.1,
"boundaryDimension": 0,
"coordinateSequence": {"measures": 0,
"dimension": 0
},
"geometryType": "string",
"numPoints": 0,
"y": 0.1,
"boundary": {"envelope": { },
"factory": {"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"coordinateSequenceFactory": { },
"srid": 0
},
"userData": { },
"simple": true,
"coordinate": {"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
},
"interiorPoint": { },
"boundaryDimension": 0,
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"geometryType": "string",
"numGeometries": 0,
"coordinates": [{"x": 0.1,
"y": 0.1,
"z": 0.1,
"m": 0.1,
"coordinate": { },
"valid": true
}
],
"numPoints": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"boundary": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"dimension": 0,
"length": 0.1,
"empty": true,
"valid": true
},
"dimension": 0,
"empty": true,
"interiorPoint": { },
"precisionModel": {"scale": 0.1,
"maximumSignificantDigits": 0,
"offsetX": 0.1,
"offsetY": 0.1,
"type": { },
"floating": true
},
"srid": 0,
"numGeometries": 0,
"rectangle": true,
"area": 0.1,
"centroid": { },
"envelopeInternal": {"diameter": 0.1,
"width": 0.1,
"height": 0.1,
"maxX": 0.1,
"maxY": 0.1,
"area": 0.1,
"null": true,
"minX": 0.1,
"minY": 0.1
},
"length": 0.1,
"valid": true
},
"street": "string",
"zip": "string",
"city": "string",
"state": "string",
"country": "string",
"isoCode": "string",
"addressExtra": "string",
"companyName": "string",
"clientName": "string",
"phoneNumber": "string",
"inOrderUsed": true,
"companyAddress": true,
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

chat-entry-controller

read_10

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId

required

string <uuid>

query Parameters

filter

string

Default: ""

Responses

create_10

This api endpoint requires CREATOR_ORDER, PLANNER_ORDER permission.

Request Body schema: application/json
required

id required	string <uuid>
createDate required	string <date-time>
modifyDate required	string <date-time>
createdBy required	string
lastModifiedBy required	string
deleted	boolean
sequenceId	integer <int64>
text required	string
orderId required	string <uuid>
companyId	string <uuid>
readStatus	boolean
person	string Enum: "ME" "YOU"
	object (Links)

Responses

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"createDate": "2019-08-24T14:15:22Z",
"modifyDate": "2019-08-24T14:15:22Z",
"createdBy": "string",
"lastModifiedBy": "string",
"deleted": true,
"sequenceId": 0,
"text": "string",
"orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5",
"companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",
"readStatus": true,
"person": "ME",
"_links": {"property1": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
},
"property2": {"href": "string",
"hreflang": "string",
"title": "string",
"type": "string",
"deprecation": "string",
"profile": "string",
"name": "string",
"templated": true
}
}
}

readUpdate

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

path Parameters

orderId

required

string <uuid>

Responses

package-item-package-class-controller

readOne_6

This api endpoint requires ADMIN_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER, MANAGER_WAREHOUSE, WORKER_WAREHOUSE permission.

path Parameters

packageItemId required	string <uuid>
packageClassId required	string <uuid>

Responses

dashboard-controller

readOrderStatus_1

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

notDeleted	boolean Default: true
filterCanceled	boolean Default: true

Responses

readOrderStatus_2

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

orderStatus

string

Default: "OPEN"

Enum: "ACCEPTED" "OPEN" "PROCESSING" "COMPLETE" "CANCELED" "REJECTED" "REQUESTED" "REVOKED" "CREATED"

Responses

getDailyOrders

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

days	integer <int32> Default: 7

Responses

chat-summary-controller

read_11

This api endpoint requires OWNER_COMPANY, CREATOR_ORDER, PLANNER_ORDER, SUPPLIER permission.

query Parameters

required

object (Pageable)

TRANSIT API (1.0.0)

user-user-property-controller

readOne

path Parameters

Responses

update

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

delete

path Parameters

Responses

partialUpdate

path Parameters

Request Body schema: application/merge-patch+jsonrequired

Responses

Request samples

read_1

path Parameters

query Parameters

Responses

create_1

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

user-controller

readOne_1

path Parameters

Responses

update_1

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

delete_1

path Parameters

Responses

partialUpdate_1

path Parameters

Request Body schema: application/merge-patch+jsonrequired

Responses

Request samples

read

query Parameters

Responses

create

Request Body schema: application/jsonrequired

Responses

Request samples

register

Request Body schema: application/jsonrequired

Responses

Request samples

getUserDTOFromAuthenticatedUser

path Parameters

Responses

getUserIdFromAuthenticatedUser

path Parameters

Responses

user-property-controller

readOne_2

path Parameters

Responses

update_2

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

delete_2

path Parameters

Responses

partialUpdate_2

path Parameters

Request Body schema: application/merge-patch+jsonrequired

Responses

Request samples

package-property-controller

readOne_3

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required

Request Body schema: application/merge-patch+json
required

Request Body schema: application/json
required