BACK-OFFICE API v1.0.0

Scroll down for code samples, example requests and responses.

"Rest API for BackOffice"

Base URLs:

localhost:8086/nst

Basic information

These web serivices can be used to manage information about backoffice inside the NST system

ApplicationPermission REST APIs V2

Permission Controller V 2

Retrieve All ApplicationPermissions

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/permissions \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/permissions

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully retrieve Permissions	NstResponseDTO_List_ApplicationPermissionDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Business unit REST APIs V2

Business Unit Controller V 2

Get all Business Unit

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/business-units \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/business-units

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all Business Unit	NstResponseDTO_List_BusinessUnitDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create Business Unit

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/business-units \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

POST /api/v2/business-units

Body parameter

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
body	body	BUConfigurationDTO	true	buConfigurationDTO

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create Business Unit	NstResponseDTO_BUConfigurationDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get Business Unit by Id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/business-units/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/business-units/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get Business Unit	NstResponseDTO_BusinessUnitDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update Business Unit

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/business-units/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v2/business-units/{id}

Body parameter

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
body	body	BusinessUnitDTO	true	businessUnitDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update Business Unit	NstResponseDTO_BUConfigurationDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get SFTP Configs by BU Id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/business-units/{id}/sftp-configs \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/business-units/{id}/sftp-configs

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get SFTP Configs	NstResponseDTO_BusinessUnitDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Activate/Deactive Business Unit

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/business-units/{id}/status \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

PUT /api/v2/business-units/{id}/status

Body parameter

{
  "active": true
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	Business Unit Id will be updated
body	body	UpdateBusinessUnitStatusDTO	true	dto

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update Business Unit status	NstResponseDTO_BusinessUnitDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

BusinessUnitInSystemController REST APIs V2

Business Unit In System Controller V 2

Get Business Unit in system

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/system-business-units/{buCode}?appName=string \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/system-business-units/{buCode}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
appName	query	string	true	appName
buCode	path	string	true	BU Code

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get Business Unit	NstResponseDTO_Boolean
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update Business Unit in system

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/system-business-units/{buCode} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v2/system-business-units/{buCode}

Body parameter

{
  "appName": "string",
  "used": true
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	path	string	true	BU Code
body	body	UpdateBUSystemUsedStatusDTO	true	updateBUSystemUsedStatusDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update Business Unit	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Customer REST APIs

Legacy Customer Controller

Retrieve Customer data by Legacy Cust Id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v1/legacy-customers/{cust-id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-CODE: string'

GET /api/v1/legacy-customers/{cust-id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-CODE	header	string	true	DPD-BU-CODE
cust-id	path	string	true	cust-id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get customer	NstResponseDTO_CustomerDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Customer Address REST APIs

Upsert Customer Address

Code samples

# You can also use wget
curl -X POST /localhost:8086/api/v1/customerAddresses/upsert \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Authorization: string'

POST /api/v1/customerAddresses/upsert

Body parameter

{
  "addressList": [
    {
      "addressEventId": "string",
      "addressId": "string",
      "city": "string",
      "contactName": "string",
      "countryCode": "string",
      "customerId": "string",
      "defaultFlag": "string",
      "depotNo": "string",
      "email": "string",
      "flatNo": "string",
      "houseNo": "string",
      "legacyID": "string",
      "name": "string",
      "name2": "string",
      "parentCustomerId": "string",
      "parentId": 0,
      "phone": "string",
      "phonePrefix": "string",
      "street": "string",
      "town": "string",
      "type": "string",
      "zipCode": "string",
      "DELIS_USER_ID":"1234"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Specific Token which inlcudes buCode and buId
body	body	UpsertAddressRequestDTO	true	Update/Insert customer data address DTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	CustomerAddressResponseDTO

Customer REST APIs V2

Customer Controller V 2

Get all customer

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/customers \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

GET /api/v2/customers

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	query	string	true	Business Unit Code
addressType	query	string	false	addressType
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get customer	NstResponseDTO_List_CustomerDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create customer

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/bu/{buCode}/customers \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \

POST /api/v2/bu/{buCode}/customers

Body parameter

{
  "addressContact": [
    {
      "addressType": "string",
      "cityName": "Ha Noi",
      "contactName": "Tran Duc Thien",
      "countryCode": "001",
      "countryName": "Viet Nam",
      "depot": "0000001",
      "email": "[email protected]",
      "flatNumber": "3601",
      "houseNo": "3601",
      "name": "Kamil",
      "name2": "Kamil",
      "phone": "3601",
      "phoneArea": "84",
      "phoneNumber": "1111222",
      "streetName": "Le Trong Tan",
      "zipCode": "001"
    }
  ],  
  "custId": "00000001",
  "customerProducts": [
    {
      "additionalProductId": 3,
      "additionalProductName": "Predict",
      "id": 1,
      "isRequired": false,
      "mainProductId": 2,
      "mainProductName": "Classic"
    }
  ],
  "customerType": 0,
  "groupIds": [
    0
  ],
  "id": 0,
  "includeCsvReport": true,
  "name": "Kamil",
  "name2": "Kamil"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	path	string(3)	true	Business Unit Code. This value is used to check the permission whether the executor can create an new Customer on this BU
body	body	CustomerValidatorDTOV2	true	customerV2

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create customer	NstResponseDTO_Long
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all address type

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/customers/address-types \
  -H 'Accept: */*'

GET /api/v2/customers/address-types

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get address type	NstResponseDTO_List_AddressTypeDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get specific customer

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/bu/{buCode}/customers/{custId} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \

GET /api/v2/bu/{buCode}/customers/{custId}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	path	string(3)	yes	Business Unit Code. This value is used to check the permission whether the executor can create an new Customer on this BU
custId	path	string(17)	true	External Customer ID

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get customer	NstResponseDTO_CustomerDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update customer

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/bu/{buCode}/customers/{custId} \
  -H 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \

PUT /api/v2/bu/buCode/{buCode}/customers/{custId}

Body parameter

{
  "addressContact": [
    {
      "addressType": "string",
      "cityName": "Ha Noi",
      "contactName": "Tran Duc Thien",
      "countryCode": "001",
      "countryName": "Viet Nam",
      "depot": "0000001",
      "email": "[email protected]",
      "flatNumber": "3601",
      "houseNo": "3601",
      "name": "Kamil",
      "name2": "Kamil",
      "phone": "3601",
      "phoneArea": "84",
      "phoneNumber": "1111222",
      "streetName": "Le Trong Tan",
      "zipCode": "001"
    }
  ]
  "custId": "00000001",
  "customerProducts": [
    {
      "additionalProductId": 3,
      "additionalProductName": "Predict",
      "id": 1,
      "isRequired": false,
      "mainProductId": 2,
      "mainProductName": "Classic"
    }
  ],
  "customerType": 0,
  "groupIds": [
    0
  ],
  "id": 0,
  "includeCsvReport": true,
  "name": "Kamil",
  "name2": "Kamil"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	path	string(3)	yes	Business Unit Code. This value is used to check the permission whether the executor can create an new Customer on this BU
custId	path	string(17)	true	External Customer ID
body	body	CustomerValidatorDTOV2	true	customerV2

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update customer	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete customer

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v2/bu/{buCode}/customers/{custId} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \

DELETE /api/v2/bu/{buCode}/customers/{custId}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	path	string(3)	yes	Business Unit Code. This value is used to check the permission whether the executor can create an new Customer on this BU
custId	path	string(17)	true	External Customer ID

Example responses

204 Response

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully delete customer	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get list of customer with no products

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/bu/{buCode}/customers/customersWithoutProducts \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET api/v2/bu/{buCode}/customers/customersWithoutProducts

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	path	string	true	Business Unit Code
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get customer	NstResponseDTO_List_CustomerCustIdsResponseDTOV2
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Dpd User REST APIs V2

Dpd User Controller V 2

Get all user

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/dpd-users \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/dpd-users

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get user	NstResponseDTO_List_DpdUserDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create user

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/dpd-users \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

POST /api/v2/dpd-users

Body parameter

{
  "businessUnits": [
    {
      "id": 0,
      "isDefault": true,
      "roleId": 1
    }
  ],
  "email": "string",
  "id": 0,
  "isBackOfficeAdmin": true,
  "languageCode": "string",
  "loginName": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
body	body	DpdUserDTOV2	true	user

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create user	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all user permission

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/dpd-users/permissions \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

GET /api/v2/dpd-users/permissions

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all permission	NstResponseDTO_List_UserRoleDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get specific user

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/dpd-users/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/dpd-users/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get user	NstResponseDTO_DpdUserDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update user

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/dpd-users/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

PUT /api/v2/dpd-users/{id}

Body parameter

{
  "businessUnits": [
    {
      "id": 0,
      "isDefault": true,
      "roleId": 1
    }
  ],
  "email": "string",
  "id": 0,
  "isBackOfficeAdmin": true,
  "languageCode": "string",
  "loginName": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id
body	body	DpdUserDTOV2	true	user

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update user	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete user

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v2/dpd-users/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

DELETE /api/v2/dpd-users/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

204 Response

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully delete user	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update User's language

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/dpd-users/{id}/languages/{languageCode} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v2/dpd-users/{id}/languages/{languageCode}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	User Id from User will be updated
languageCode	path	string	true	Language code

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update User	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Elements REST APIs V2

Element Controller V 2

Get all Elements

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/elements \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

GET /api/v2/elements

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all element	NstResponseDTO_List_ElementDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

External GroupId REST APIs

External Group Id Controller

Get all groupId

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/group-id \
  -H 'Accept: */*'

GET /kong/v1/group-id

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	Limit the number of groups in output. If it's not inputted, use default value as "10".
offset	query	integer(int32)	false	The page of returned group if limit is inputted. If it's not inputted, use default value as "0".
sort	query	string	false	- Sorting in the output: - Use "-" for descending sort, and "+" for ascending sort. - Support to sort the following fields: id, name
buCode	query	string	false	Business Unite Code. Search exact
groupType	query	string	false	Type of Group id. Search exact, not case sensitive

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Get all group id successfully	GroupIdGetAllResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
500	Internal Server Error	Internal Server Error	None

Create GroupId

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/kong/v1/group-id \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

POST /kong/v1/group-id

Body parameter

{
  "customers": [
    {
      "buCode": "string",
      "customerId": "string"
    }
  ],
  "name": "string",
  "type": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	GroupIdRequestExternalDTO	true	requestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Create group id successfully	GroupIdResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
500	Internal Server Error	Internal Server Error	None

Assign more customers into specific GroupId

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/kong/v1/group-id/assign-customers/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

PUT /kong/v1/group-id/assign-customers/{id}

Body parameter

{
  "customers": [
    {
      "buCode": "string",
      "customerId": "string"
    }
  ],
  "name": "string",
  "type": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	id
body	body	GroupIdRequestExternalDTO	true	requestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Update group id successfully	GroupIdResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

Get groupId by id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/group-id/{id} \
  -H 'Accept: */*'

GET /kong/v1/group-id/{id}

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Get group id successfully	GroupIdGetterResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

Update GroupId

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/kong/v1/group-id/{id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*'

PUT /kong/v1/group-id/{id}

Body parameter

{
  "customers": [
    {
      "buCode": "string",
      "customerId": "string"
    }
  ],
  "name": "string",
  "type": "string"
}

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	id
body	body	GroupIdRequestExternalDTO	true	requestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Update group id successfully	GroupIdResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

Delete GroupId

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/kong/v1/group-id/{id} \
  -H 'Accept: */*'

DELETE /kong/v1/group-id/{id}

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Delete group id successfully	GroupIdResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

GroupId REST APIs

Group Id Controller

Get all groupId

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v1/group-id/group-types \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v1/group-id/group-types

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Get all group id successfully	NstResponseDTO_List_String
401	Unauthorized	You are not authorized to view the resource	None
500	Internal Server Error	Internal Server Error	None

Create GroupId

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v1/group-id \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

POST /api/v1/group-id

Body parameter

{
  "customers": [
    {
      "buId": 0,
      "customerId": 0
    }
  ],
  "name": "string",
  "type": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
body	body	GroupIdRequestDTO	true	requestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Create group id successfully	NstResponseDTO_Long
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
500	Internal Server Error	Internal Server Error	None

Assign more customers into specific GroupId

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v1/group-id/assign-customers/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v1/group-id/assign-customers/{id}

Body parameter

{
  "customers": [
    {
      "buId": 0,
      "customerId": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
body	body	GroupIdCustomerListDTO	true	requestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Update group id successfully	GroupIdResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

Get groupId by id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v1/group-id/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v1/group-id/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Get group id successfully	NstResponseDTO_GroupIdGetterDTO
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

Update GroupId

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v1/group-id/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v1/group-id/{id}

Body parameter

{
  "customers": [
    {
      "buId": 0,
      "customerId": 0
    }
  ],
  "name": "string",
  "type": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
body	body	GroupIdRequestDTO	true	requestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Update group id successfully	NstResponseDTO_Long
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

Delete GroupId

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v1/group-id/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

DELETE /api/v1/group-id/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Delete group id successfully	NstResponseDTO_Long
401	Unauthorized	You are not authorized to view the resource	None
404	Not Found	Not found	None
500	Internal Server Error	Internal Server Error	None

I18n REST APIs V2

I 18n Controller V 2

Get i18n

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/v2/public/i18n \
  -H 'Accept: */*'

GET /v2/public/i18n

Parameters

Name	In	Type	Required	Description
lang	query	string	false	lang

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get i18n	Inline
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Master data REST APIs V2

Master Data Controller V 2

Get all master data

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/v2/public/master-data \
  -H 'Accept: */*'

GET /v2/public/master-data

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all master data	NstResponseDTO_MasterDataDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all cod payment type

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/v2/public/master-data/cod-payment-types \
  -H 'Accept: */*'

GET /v2/public/master-data/cod-payment-types

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all cod payment type	NstResponseDTO_List_CODPaymentTypeDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all currencies

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/v2/public/master-data/currencies \
  -H 'Accept: */*'

GET /v2/public/master-data/currencies

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all currencies	NstResponseDTO_List_CurrencyDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all languages

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/v2/public/master-data/languages \
  -H 'Accept: */*'

GET /v2/public/master-data/languages

Parameters

Name	In	Type	Required	Description
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all languages	NstResponseDTO_List_LanguageDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Parcel Range REST APIs V2

Parcel Range Controller V 2

Get all Parcel ranges

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/parcel-ranges \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/parcel-ranges

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all Parcel ranges	NstResponseDTO_List_ParcelRangeDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create Parcel range

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/parcel-ranges \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

POST /api/v2/parcel-ranges

Body parameter

{
  "businessUnits": [
    {
      "id": 0
    }
  ],
  "customerId": 0,
  "depotNo": "string",
  "id": 0,
  "isApplyForBU": true,
  "parcelRangeType": "CUSTOMER",
  "rangeEnd": 100,
  "rangeStart": 100,
  "senderAddressId": 0
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
body	body	ParcelRangeDTOV2	true	parcelRange

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create Parcel range	NstResponseDTO_ParcelRangeDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get Parcel range by id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/parcel-ranges/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/parcel-ranges/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get Parcel range	NstResponseDTO_ParcelRangeDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete Parcel range by id

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v2/parcel-ranges/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

DELETE /api/v2/parcel-ranges/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

204 Response

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully delete Parcel range	NstResponseDTO_Void
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update Parcel range use in wpo by id

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/parcel-ranges/{id}/wpo-enable-status?enable=true \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

PUT /api/v2/parcel-ranges/{id}/wpo-enable-status

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
enable	query	boolean	true	enable
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update Parcel range use in wpo	NstResponseDTO_Void
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Products REST APIs V2

Product Configuration Controller V 2

Get all Product configuration

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/products \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/products

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
fromCountry	query	string	false	fromCountry
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort
toCountry	query	string	false	toCountry

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all Product configuration	NstResponseDTO_List_ProductResponseDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create Product configuration

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/products \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

POST /api/v2/products

Body parameter

{
  "additionalProductIds": [
    0
  ],
  "businessUnits": [
    {
      "id": 0
    }
  ],
  "collectionRequest": true,
  "description": "string",
  "displayOnLabel": true,
  "elements": [
    0
  ],
  "id": 0,
  "isMandatoryDimension": true,
  "isMandatoryWeight": true,
  "mainProductIds": [
    0
  ],
  "mainProductType": 0,
  "mandatoryProductIds": [
    0
  ],
  "mpsOption": 0,
  "name": "string",
  "serviceType": 0,
  "shippingRestrictions":[
    {
      "fromCode": "PL",
      "fromName": "Poland",
      "restrictionToList": [
          {
            "toName": "Poland",
            "toCode": "PL"
          },
          {
            "toName": "Viet Nam",
            "toCode": "VN"
          }
        ],
        "zipCodeRestrictionList": [
          {
            "fromRange": "02776",
            "toRange": "02777"
          }
        ]
    }
  ]
  ,
  "swapBackElements": [
    0
  ],
  "translations": [
    {
      "description": "string",
      "id": 0,
      "languageCode": "string",
      "name": "string",
      "productId": 0
    }
  ],
  "type": 0
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
body	body	CreationProductRequestDTOV2	true	creationProductRequestDTO

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create Product configuration	NstResponseDTO_Long
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get Product configuration by Id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/products/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

GET /api/v2/products/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get Product configuration	NstResponseDTO_ProductResponseOneLevelDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update Product configuration

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/products/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

PUT /api/v2/products/{id}

Body parameter

{
  "additionalProductIds": [
    0
  ],
  "businessUnits": [
    {
      "id": 0
    }
  ],
  "collectionRequest": true,
  "description": "string",
  "displayOnLabel": true,
  "elements": [
    0
  ],
  "id": 0,
  "isMandatoryDimension": true,
  "isMandatoryWeight": true,
  "mainProductIds": [
    0
  ],
  "mainProductType": 0,
  "mandatoryProductIds": [
    0
  ],
  "mpsOption": 0,
  "name": "string",
  "serviceType": 0,
  "shippingRestrictions":[
    {
      "fromCode": "PL",
      "fromName": "Poland",
      "restrictionToList": [
          {
            "toName": "Poland",
            "toCode": "PL"
          },
          {
            "toName": "Viet Nam",
            "toCode": "VN"
          }
        ],
        "zipCodeRestrictionList": [
          {
            "fromRange": "02776",
            "toRange": "02777"
          }
        ]
    }
  ],
  "swapBackElements": [
    0
  ],
  "translations": [
    {
      "description": "string",
      "id": 0,
      "languageCode": "string",
      "name": "string",
      "productId": 0
    }
  ],
  "type": 0
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id
body	body	CreationProductRequestDTOV2	true	updationProductRequestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update Product configuration	NstResponseDTO_Void
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete Product configuration by Id

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v2/products/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

DELETE /api/v2/products/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

204 Response

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully delete Product configuration	Inline
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Reason code REST APIs V2

Reason Code Controller V 2

Get all Reason codes

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/reason-codes \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/reason-codes

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all Reason codes	NstResponseDTO_List_ReasonCodeDTO
400	Bad Request	Bad request	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Routing REST APIs V2

Routing Controller V 2

Get all Business Unit

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/routes/business-units \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/routes/business-units

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get Business Units	NstResponseDTO_List_BusinessUnitDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all City

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/routes/cities?countryCode=string&postcode=string \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/routes/cities

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
countryCode	query	string	true	countryCode
postcode	query	string	true	postcode

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get Cities	NstResponseDTO_CityDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all depot

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/routes/depots?buCode=string \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/routes/depots

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
buCode	query	string	true	buCode

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get depots	Inline
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Validate postcode

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/routes/postcode/validations?countryCode=string&postcode=string \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/routes/postcode/validations

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
countryCode	query	string	true	countryCode
postcode	query	string	true	postcode

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Validate without error	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

User REST APIs V2

Customer User Controller V 2

Get all user

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/users \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/users

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
email	query	string	false	email
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all user	NstResponseDTO_List_GetCustomerUserDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create user

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/users \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

POST /api/v2/users

Body parameter

{
  "customers": [
    {
      "businessUnits": [
        {
          "id": 0
        }
      ],
      "customerRoles": [
        {
          "id": 0
        }
      ],
      "defaultAddress": {
        "id": 0
      },
      "id": 0,
      "isDefaultCustomer": true
    }
  ],
  "email": "string",
  "id": 0,
  "languageCode": "string",
  "loginName": "string",
  "name": "string",
  "phone": "string",
  "phoneArea": "string",
  "phoneNumber": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
body	body	CustomerUserProfileDTOV2	true	user

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create user	NstResponseDTO_Long
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get all user permission

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/users/permissions \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'customerId: string'

GET /api/v2/users/permissions

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
customerId	header	string	true	customerId

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get all permission	NstResponseDTO_List_UserRoleDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get specific user

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/users/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
buCode	query	string	true	Business Unit Code
groupType	query	string	false	Type of groupsId

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get user	NstResponseDTO_GetCustomerUserDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get specific user by mail

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/users/mail \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v2/users/mail

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
mail	query	string	true	Email of User
buCode	query	string	true	Business Unit Code
groupType	query	string	false	Type of groupsId

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get user	NstResponseDTO_GetCustomerUserDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update user

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/users/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v2/users/{id}

Body parameter

{
  "customers": [
    {
      "businessUnits": [
        {
          "id": 0
        }
      ],
      "customerRoles": [
        {
          "id": 0
        }
      ],
      "defaultAddress": {
        "id": 0
      },
      "id": 0,
      "isDefaultCustomer": true
    }
  ],
  "email": "string",
  "id": 0,
  "languageCode": "string",
  "loginName": "string",
  "name": "string",
  "phone": "string",
  "phoneArea": "string",
  "phoneNumber": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
body	body	CustomerUserProfileDTOV2	true	user

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update user	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete user

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v2/users/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

DELETE /api/v2/users/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

204 Response

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully delete user	Inline
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Patch Update User

Code samples

# You can also use wget
curl -X PATCH /localhost:8086/nst/api/v2/users/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

PATCH /api/v2/users/{id}

Body parameter

{
  "languageCode": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
id	path	integer(int64)	true	User Id from User will be patched
body	body	PatchUserRequestDTO	true	patchUserRequestDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully patch update User	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource were trying to reach is not found	None

Change password

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/users/{id}/password \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v2/users/{id}/password

Body parameter

{
  "newPassword": "string",
  "oldPassword": "string",
  "userId": 0
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
body	body	PasswordDTO	true	passwordDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully change password	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Force reset password

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v2/users/{id}/password \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

DELETE /api/v2/users/{id}/password

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

204 Response

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully delete password and send email	Inline
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

User role REST APIs V2

User Role Controller V 2

Get all user role

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/roles \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

GET /api/v2/roles

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get role	NstResponseDTO_List_RoleDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create user role

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/roles \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

POST /api/v2/roles

Body parameter

{
  "applications": [
    {
      "id": 0,
      "name": "string",
      "permissions": [
        {
          "appId": 0,
          "description": "string",
          "id": 0,
          "name": "string",
          "object": "string",
          "type": "string",
          "userType": "string"
        }
      ],
      "type": "string"
    }
  ],
  "description": "string",
  "id": 0,
  "roleName": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
body	body	RoleDTO	true	roleDTO

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create role	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get user role by id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v2/roles/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

GET /api/v2/roles/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get role	NstResponseDTO_RoleDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update user role

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v2/roles/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

PUT /api/v2/roles/{id}

Body parameter

{
  "applications": [
    {
      "id": 0,
      "name": "string",
      "permissions": [
        {
          "appId": 0,
          "description": "string",
          "id": 0,
          "name": "string",
          "object": "string",
          "type": "string",
          "userType": "string"
        }
      ],
      "type": "string"
    }
  ],
  "description": "string",
  "id": 0,
  "roleName": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
id	path	integer(int64)	true	id
body	body	RoleDTO	true	roleDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update role	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete user role

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v2/roles/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: 0'

DELETE /api/v2/roles/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	integer(int64)	true	DPD-BU-ID
id	path	integer(int64)	true	id

Example responses

204 Response

Responses

Status	Meaning	Description	Schema
204	No Content	Successfully delete role	Inline
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Budah instance REST APIs

Register budah

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v1/budah-registration \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

POST /api/v1/budah-registration

Body parameter

{
  "consumerId": 0,
  "filter": {
    "originBU": [
      "string"
    ]
  },
  "name": "string",
  "password": "string",
  "status": "string",
  "type": "string",
  "url": "string",
  "username": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
body	body	BudahInstanceDTO	true	instance

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	NstResponseDTO_BudahInstanceDTO
201	Created	Successfully register budah	NstResponseDTO_BudahInstanceDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update budah

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v1/budah-registration/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v1/budah-registration/{id}

Body parameter

{
  "consumerId": 0,
  "filter": {
    "originBU": [
      "string"
    ]
  },
  "name": "string",
  "password": "string",
  "status": "string",
  "type": "string",
  "url": "string",
  "username": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
body	body	BudahInstanceDTO	true	instance

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	NstResponseDTO_BudahInstanceDTO
201	Created	Successfully update budah	NstResponseDTO_BudahInstanceDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete budah

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v1/budah-registration/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

DELETE /api/v1/budah-registration/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	OK	NstResponseDTO_BudahInstanceDTO
201	Created	Successfully delete budah	NstResponseDTO_BudahInstanceDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

CustomerUser role REST APIs V2

Get all customer user role

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v1/customer-roles \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v1/customer-roles

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
limit	query	integer(int32)	false	limit
offset	query	integer(int64)	false	offset
search	query	string	false	search
sort	query	string	false	sort

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get role	NstResponseDTO_List_RoleDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Create customer user role

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v1/customer-roles \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

POST /api/v1/customer-roles

Body parameter

{
  "applications": [
    {
      "id": 0,
      "name": "string",
      "permissions": [
        {
          "appId": 0,
          "description": "string",
          "id": 0,
          "name": "string",
          "object": "string",
          "type": "string",
          "userType": "string"
        }
      ],
      "type": "string"
    }
  ],
  "description": "string",
  "id": 0,
  "roleName": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
body	body	RoleDTO	true	roleDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully create role	NstResponseDTO_CustomerRoleDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get customer user role by id

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/api/v1/customer-roles/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

GET /api/v1/customer-roles/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get role	NstResponseDTO_RoleDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Update customer user role

Code samples

# You can also use wget
curl -X PUT /localhost:8086/nst/api/v1/customer-roles/{id} \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

PUT /api/v1/customer-roles/{id}

Body parameter

{
  "applications": [
    {
      "id": 0,
      "name": "string",
      "permissions": [
        {
          "appId": 0,
          "description": "string",
          "id": 0,
          "name": "string",
          "object": "string",
          "type": "string",
          "userType": "string"
        }
      ],
      "type": "string"
    }
  ],
  "description": "string",
  "id": 0,
  "roleName": "string"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id
body	body	RoleDTO	true	roleDTO

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully update role	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Delete customer user role

Code samples

# You can also use wget
curl -X DELETE /localhost:8086/nst/api/v1/customer-roles/{id} \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}'

DELETE /api/v1/customer-roles/{id}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
id	path	integer(int64)	true	id

Example responses

200 Response

Responses

Status	Meaning	Description	Schema
200	OK	Successfully delete role	NstResponseDTO_Void
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Customer Support API V2

Create customer support token

Code samples

# You can also use wget
curl -X POST /localhost:8086/nst/api/v2/customer-support/token \
  -H 'Content-Type: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer {{access_token}}' \
  -H 'DPD-BU-ID: string'

POST /api/v2/customer-support/token

Body parameter

{
  "custId": "00000001"
}

Parameters

Name	In	Type	Required	Description
Authorization	header	string	true	Authorization
DPD-BU-ID	header	string	true	DPD-BU-ID
body	body	BaseCustomerProfileDTO	true	customer

Example responses

201 Response

Responses

Status	Meaning	Description	Schema
201	Created	Successfully create token	NstResponseDTO_CustomerSupportTokenResponseDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Georouting webservices

Validate city

This API is used to validate a city name matches to a country code.

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/city-validation?cityName=string&countryCode=string \
  -H 'Accept: */*'

GET /kong/v1/city-validation

Parameters

Name	In	Type	Required	Description
cityName	query	string	true	Name of inputted City.
countryCode	query	string	true	Code of inputted Country with length = 2 (e.g. LV, FR,...).

Example responses

200 Response

{
    "statusCode": "OK"
}

Responses

Status	Meaning	Description	Schema
200	OK	Valid city	NstResponseDTO
400	Bad Request	Invalid city	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Get city by Country code and Postal code

This API is used to get list of cities based on country code and postal code.

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/get-city \
  -H 'Accept: */*'

GET /kong/v1/get-city

Parameters

Name	In	Type	Required	Description
countryCode	query	string	false	Code of inputted Country with length = 2 (e.g. LV, FR,...).
postcode	query	string	false	Post code with max-length = 4, accept only 0-9A-Z.

Example responses

200 Response

{
    "countryCode": "PL",
    "beginPostCode": "62262",
    "endPostCode": "62262",
    "cityNameEnglish": "FALKOWO",
    "cityNameLocal": "FAŁKOWO",
    "stateCode": "",
    "cityNameLocalLang": "PL"
}

400 Response

{
    "messages": [
        {
            "code": "IV106",
            "content": "Input validation postal code not matching with destination country postcode pattern",
            "messageType": "ERROR"
        }
    ],
    "statusCode": "BAD_REQUEST"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully get city	CityDTO
400	Bad Request	Invalid city	NstResponseDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Validate Postcode

This API is used to validate postcode based on inputted country code.

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/postcode-validation?countryCode=string&postcode=string \
  -H 'Accept: */*'

GET /kong/v1/postcode-validation

Parameters

Name	In	Type	Required	Description
countryCode	query	string	true	Code of inputted Country with length = 2 (e.g. LV, FR,...).
postcode	query	string	true	Post code with max-length = 4, accept only 0-9A-Z.

Example responses

200 Response

{
    "statusCode": "OK"
}

Responses

Status	Meaning	Description	Schema
200	OK	Valid Postcode	NstResponseDTO
400	Bad Request	Invalid Postcode	None
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Select Product

This API is used to get all possible products to a specified destination country and postcode.

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/product-selection?dCountry=string&dPostCode=string&elementCodes=string&oDepot=string \
  -H 'Accept: */*'

GET /kong/v1/product-selection

Parameters

Name	In	Type	Required	Description
asCode	query	string	false	Additional service code. Three characters to start then up to 6 characters (RFU).
cityName	query	string	false	Name of inputted City
dCountry	query	string	true	Destination country. The destination country is the country where the parcel is to be sent.
dDepot	query	string	false	Destination depot: should always be the depot of delivery or the last known Geopost depot, even if the franchisee /partner uses an alien system.
dNetwork	query	string	false	Destination network code. Optionally when a parcel needs to be re-routed. This parameter can be used also when we want to force the destination network.
dPostCode	query	string	true	Destination postal code. The postal code of the location where the parcel is to be sent.
date	query	string	false	Date of routing. The date when the parcel was routed.
elementCodes	query	string	true	Elements are describing the service characteristics: Sorting, additional or non operational service element code.
exactMatchOnElements	query	boolean	false	None
oDepot	query	string	true	oDepot/tradeStatus
soCode	query	string	false	GeoPost Service Code / GeoPost Sorting Code. The sorting code must be used as an input parameter to determine where to route the parcel and if the service is allowed.
subCode	query	string	false	The last 2 digits of the injection code. The sub code identifies a special routing case of a depot, when the origin routing should not be based on the ODEPOT
tradeStatus	query	string	false	Trade status. The status of the customs clearance.

Example responses

200 Response

{
    "data": [
        {
            "soCode": "400",
            "asCode": "A17",
            "odgroup": "",
            "ddgroup": "",
            "zdPostCode": "01001",
            "buCode": "021",
            "soCodeElements": [
                "001"
            ],
            "asCodeElements": [
                "100"
            ]
        }
    ],
    "statusCode": "OK"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully select Product	NstResponseDTO_List_ProductSelectionRouteResponseDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Calculate Route

This API is used to calculate the route, means the information necessary to sort the parcel at different phases of the transport chain from sending depot to delivery. This information is printed on the GeoPost label.

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/route-calculation?dCountry=string&dPostCode=string&oDepot=string&soCode=string \
  -H 'Accept: */*'

GET /kong/v1/route-calculation

Parameters

Name	In	Type	Required	Description
asCode	query	string	false	Additional service code. Three characters to start then up to 6 characters (RFU).
cityName	query	string	false	Name of inputted City
dCountry	query	string	true	Destination country. The destination country is the country where the parcel is to be sent.
dDepot	query	string	false	Destination depot: should always be the depot of delivery or the last known Geopost depot, even if the franchisee /partner uses an alien system.
dNetwork	query	string	false	Destination network code. Optionally when a parcel needs to be re-routed. This parameter can be used also when we want to force the destination network.
dPostCode	query	string	true	Destination postal code. The postal code of the location where the parcel is to be sent.
date	query	string	false	Date of routing. The date when the parcel was routed.
oDepot	query	string	true	oDepot/tradeStatus
soCode	query	string	true	GeoPost Service Code / GeoPost Sorting Code. The sorting code must be used as an input parameter to determine where to route the parcel and if the service is allowed
subCode	query	string	false	The last 2 digits of the injection code. The sub code identifies a special routing case of a depot, when the origin routing should not be based on the ODEPOT.
tradeStatus	query	string	false	Trade status. The status of the customs clearance.

Example responses

200 Response

{
    "data": {
        "buCode": "021",
        "networkCode": "616",
        "dCountry": "PL",
        "dDepotCountry": "PL",
        "dDepot": "0211349",
        "dDepotStr": "1349",
        "sSort": "WA3",
        "partnerCode": "",
        "oSort": "WA3",
        "cSort": "",
        "dSort": "WO10",
        "barcodeId": "%",
        "serviceText": "D",
        "serviceMark": "",
        "version": "21070504",
        "barcodePostcode": "0001001",
        "warningList": [],
        "buAlphaStr": "DPD"
    },
    "statusCode": "OK"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculate Route	NstResponseDTO_RouteResultDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Calculate Route with Elements

This API is used to calculate the information of routing with element.

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/route-calculation-with-element?dCountry=string&dPostCode=string&elementCodes=string&oDepot=string \
  -H 'Accept: */*'

GET /kong/v1/route-calculation-with-element

Parameters

Name	In	Type	Required	Description
cityName	query	string	false	Name of inputted City.
dCountry	query	string	true	Destination country. The destination country is the country where the parcel is to be sent.
dNetwork	query	string	false	Destination network code. Optionally when a parcel needs to be re-routed. This parameter can be used also when we want to force the destination network.
dPostCode	query	string	true	Destination postal code. The postal code of the location where the parcel is to be sent.
date	query	string	false	Date of routing. The date when the parcel was routed.
elementCodes	query	string	true	Elements are describing the service characteristics: Sorting, additional or non operational service element code.
oDepot	query	string	true	oDepot/tradeStatus
subCode	query	string	false	The last 2 digits of the injection code. The sub code identifies a special routing case of a depot, when the origin routing should not be based on the ODEPOT.
tradeStatus	query	string	false	Trade status. The status of the customs clearance.

Example responses

200 Response

{
    "data": {
        "buCode": "021",
        "networkCode": "616",
        "dCountry": "PL",
        "dDepotCountry": "PL",
        "dDepot": "0211349",
        "dDepotStr": "1349",
        "sSort": "WA3",
        "partnerCode": "",
        "oSort": "WA3",
        "cSort": "",
        "dSort": "WO10",
        "barcodeId": "%",
        "serviceText": "D",
        "serviceMark": "",
        "version": "21070504",
        "barcodePostcode": "0001001",
        "warningList": [],
        "soCode": "101",
        "asCode": "",
        "buAlphaStr": "DPD"
    },
    "statusCode": "OK"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculate Route with Elements	NstResponseDTO_RouteResultDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Calculate Collection Route

This API is used to calculate the Routing information for Collection request

Code samples

# You can also use wget
curl -X GET /localhost:8086/nst/kong/v1/route-collection-calculation?collectingCountry=string&collectingPostCode=string&collectionDate=string&deliveryCountry=string&deliveryPostCode=string&requestingBu=string&requestingCountry=string&soCode=string \
  -H 'Accept: */*'

GET /kong/v1/route-collection-calculation

Parameters

Name	In	Type	Required	Description
asCode	query	string	false	Additional service code. Three characters to start then up to 6 characters (RFU).
collectingBu	query	string	false	Collecting Business Unit Code.
collectingCity	query	string	false	City name of Collecting BU.
collectingCountry	query	string	true	Alpha-2 Country code of Collecting BU (e.g. LV, FR,...).
collectingPostCode	query	string	true	Post code of Collecting BU with max-length = 4, accept only 0-9A-Z
collectionDate	query	string	true	Date of collection
deliveryCityName	query	string	false	Deliver Collection request to this City Name.
deliveryCountry	query	string	true	Deliver Collection request to this Country Code (e.g. LV, FR,...).
deliveryNetwork	query	string	false	Delivery network code.
deliveryPostCode	query	string	true	Deliver Collection request to this Post Code.
requestingBu	query	string	true	Requesting Business Unit Code.
requestingCountry	query	string	true	Alpha-2 Country code of Requesting BU (e.g. LV, FR,...).
soCode	query	string	true	GeoPost Service Code / GeoPost Sorting Code. The sorting code must be used as an input parameter to determine where to route the parcel and if the service is allowed.
subCode	query	string	false	The last 2 digits of the injection code. The sub code identifies a special routing case of a depot, when the origin routing should not be based on the ODEPOT.
tradeStatus	query	string	false	Trade status. The status of the customs clearance.

Example responses

200 Response

{
    "data": {
        "collectionData": {
            "collectingDepot": "0211349",
            "collectingBu": "021",
            "workingDayDate": "2021-03-10T23:00:00.000+00:00",
            "warningList": []
        },
        "routeResult": {
            "buCode": "021",
            "networkCode": "616",
            "dCountry": "PL",
            "dDepotCountry": "PL",
            "dDepot": "0211349",
            "dDepotStr": "1349",
            "sSort": "WA3",
            "partnerCode": "",
            "oSort": "WA3",
            "cSort": "",
            "dSort": "WO10",
            "barcodeId": "%",
            "serviceText": "D",
            "serviceMark": "",
            "version": "20110201",
            "barcodePostcode": "0001001",
            "warningList": [],
            "buAlphaStr": "DPD"
        }
    },
    "statusCode": "OK"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successfully calculate Collection Route	NstResponseDTO_CrCollectionAndRouteResultDTO
401	Unauthorized	You are not authorized to view the resource	None
403	Forbidden	Accessing the resource you were trying to reach is forbidden	None
404	Not Found	The resource you were trying to reach is not found	None

Schemas

AddressTypeDTO

Properties

Name	Type	Required	Description
code	integer(int32)	false	none
name	string	false	none

AppLinkDTO

Properties

Name	Type	Required	Description
appId	string	false	none
links	[LinkDTO]	false	none

ApplicationPermissionDTO

Properties

Name	Type	Required	Description
appId	integer(int64)	false	none
description	string	false	none
id	integer(int64)	false	none
name	string	false	none
object	string	false	none
type	string	false	none
userType	string	false	none

BUConfigurationDTO

Properties

Name	Type	Required	Description
buConfigurationFields	[BUConfigurationFieldDTO]	false	none
buId	integer(int64)	false	none
codAmountConfigs	[CODCountryAmountConfigDTO]	false	none
id	integer(int64)	false	none
insAmountConfigs	[HiAmountConfigDTO]	false	none
legalDisclaimer	string	false	none
pickupZoneConfigFields	[BUConfigurationFieldDTO]	false	none
reasonCodeConfigs	[BuReasonCodeConfigDTO]	false	none

BUConfigurationFieldDTO

Properties

Name	Type	Required	Description
configName	string	false	none
configType	string	false	none
configValue	string	false	none
id	integer(int64)	false	none
ordered	integer(int32)	false	none
sectionName	string	false	none

Enumerated Values

Property	Value
configType	STRING
configType	NUMBER
configType	BOOLEAN
configType	DATE
configType	TIME
configType	LIST

BankAccountDTO

Properties

Name	Type	Required	Description
accountHolder	string	false	none
accountName	string	false	Bank Account Name.
bankAccount	string	false	Bank Account Number.
bankAccountEventId	integer(int64)	false	none
bankAccountId	string	false	none
bankBranch	string	false	none
bankBranchId	string	false	none
bankCode	string	false	Bank Code.
bankCountry	string	false	none
bankId	string	false	none
bankName	string	false	Bank Name.
bic	string	false	Bank Identifier Code.
buId	integer(int64)	false	none
customerId	string	false	none
defaultFlag	boolean	false	none
iban	string	false	International bank account number.
id	integer(int64)	false	none
lastModifiedDate	string(date-time)	false	none
status	integer(int32)	false	none

BaseCustomerProfileDTO

Properties

Name	Type	Required	Description
custId	string	false	none

BuReasonCodeConfigDTO

Properties

Name	Type	Required	Description
assignedAction	integer(int32)	false	none
assignedActionName	string	false	none
description	string	false	none
reasonCode	string	false	none

BudahInstanceDTO

Properties

Name	Type	Required	Description
consumerId	integer(int64)	false	none
filter	BudahInstanceFilter	false	none
name	string	false	none
password	string	false	none
status	string	false	none
type	string	false	none
url	string	false	none
username	string	false	none

BudahInstanceFilter

Properties

Name	Type	Required	Description
originBU	[string]	false	none

BusinessUnitDTO

Properties

Name	Type	Required	Description
buAlphaStr	string	false	none
buCode	string	false	none
buConfiguration	BUConfigurationDTO	false	none
buConfigurationId	integer(int64)	false	none
buCountryCode	string	false	none
buDefaultCountry	string	false	none
buFinancialGroup	string	false	none
buGeographGroup	string	false	none
buName	string	false	none
buStatus	integer(int32)	false	none
buTechnicalGroup	string	false	none
dpdContract	string	false	none
id	integer(int64)	false	none
legalDisclaimer	string	false	none
name	string	false	none
sftpConfigs	[SFTPServerConfig]	false	none
supportedLanguages	string	false	none
typeOfBu	string	false	none

BusinessUnitDTOV2

Properties

Name	Type	Required	Description
id	integer(int64)	false	none

CODCountryAmountConfigDTO

Properties

Name	Type	Required	Description
countryCode	string	false	none
currencies	[CODCurrencyConfigDTO]	false	none

CODCurrencyConfigDTO

Properties

Name	Type	Required	Description
currency	string	false	none
isDefault	boolean	false	none
maxAmount	number(double)	false	none

CODPaymentTypeDTO

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
paymentType	string	true	none

CityDTO

Properties

Name	Type	Required	Description
beginPostCode	string	false	none
cityNameEnglish	string	false	none
cityNameLocal	string	false	none
cityNameLocalLang	string	false	none
countryCode	string	false	none
endPostCode	string	false	none
stateCode	string	false	none

CountryDTO

Properties

Name	Type	Required	Description
countryCode2	string	true	none
countryCode3	string	true	none
countryName	string	false	none
countryNameUpperCase	string	false	none
id	integer(int64)	false	none
language	string	false	none
numCode	integer(int32)	true	none
phoneCode	integer(int32)	true	none

CrCollectionAndRouteResultDTO

Properties

Name	Type	Required	Description
collectionData	CrCollectionDataDTO	false	none
routeResult	RouteResultDTO	false	none

CrCollectionDataDTO

Properties

Name	Type	Required	Description
collectingBu	string	false	none
collectingDepot	string	false	none
warningList	[GeoWarningDTO]	false	none
workingDayDate	string(date-time)	false	none

CreationProductRequestDTOV2

Properties

Name	Type	Required	Description
additionalProductIds	[integer]	false	none
businessUnits	[BusinessUnitDTOV2]	false	none
collectionRequest	boolean	false	none
description	string	false	none
displayOnLabel	boolean	false	none
elements	[integer]	false	none
id	integer(int64)	false	none
isMandatoryDimension	boolean	false	none
isMandatoryWeight	boolean	false	none
mainProductIds	[integer]	false	none
mainProductType	integer(int32)	false	none
mandatoryProductIds	[integer]	false	none
mpsOption	integer(int32)	false	none
name	string	false	none
serviceType	integer(int32)	false	none
shippingRestrictions	[ShippingRestrictionDTO]	false	none
swapBackElements	[integer]	false	none
translations	[TranslationDTO]	false	none
type	integer(int32)	false	none

CurrencyDTO

Properties

Name	Type	Required	Description
currencyCode	string	true	none
currencyName	string	true	none
id	integer(int64)	false	none
symbol	string	false	none

CustomerAddressContactDTOV2

Properties

Name	Type	Required	Description
id	integer(int64)	false	none

CustomerAddressDTO

Properties

Name	Type	Required	Description
additionalAddressInfo	string	false	none
address	string	false	none
address1	string	false	none
address2	string	false	none
address3	string	false	none
addressEventId	string	false	none
addressId	string	false	none
addressType	string	false	none
addressTypeName	string	false	Name of address type
building	string	false	none
cityName	string	false	Street name
companyName	string	false	none
companyName2	string	false	none
contactName	string	false	none
countryCode	string	false	Country code alpha-2 (e.g. LV, FR,...) or alpha-3.
countryName	string	false	Contact name.
custId	string	false	Unique Customer ID which will be used in all systems.
customerId	string	false	none
defaultFlag	boolean	false	none
department	string	false	none
depot	string	true	Depot number of current address.
depotNo	string	false	none
doorCode	string	false	none
email	string	false	Email address.
fax	string	false	none
faxArea	string	false	none
faxNumber	string	false	Flat number
flatNumber	string	false	none
floor	string	false	none
houseNo	string	false	House number.
id	integer(int64)	false	Internal customer ID.
interphoneName	string	false	none
lastModifiedDate	string(date-time)	false	none
latitude	string	false	none
legacyAddressId	integer(int64)	false	none
legacyCustId	string	false	none
longitude	string	false	none
mobile	string	false	none
mobileArea	string	false	none
mobileNumber	string	false	none
name	string	true	Customer name in current address.
name2	string	false	Customer name 2 in current address.
phone	string	false	Phone number with phone prefix.
phoneArea	string	false	Phone prefix.
phoneNumber	string	false	Phone number
stateCode	string	false	none
status	integer(int32)	false	Status of address,it can be one of the following value: 0 and 1
streetName	string	false	Street name
town	string	false	none
types	[string]	false	none
userId	integer(int64)	false	none
zipCode	string	false	Zip code.

CustomerAddressValidatorDTOV2

Properties

Name	Type	Required	Description
addressType	string	false	none
cityName	string	true	none
contactName	string(35)	true	none
countryCode	string	true	none
countryName	string	true	none
depot	string	true	none
email	string	true	none
flatNumber	string	false	none
houseNo	string	true	none
name	string	true	none
name2	string	false	none
phone	string	false	none
phoneArea	string	true	none
phoneNumber	string	true	none
streetName	string	true	none
zipCode	string	true	none

CustomerDTO

Properties

Name	Type	Required	Description
addressContact	[CustomerAddressDTO]	false	List Address contact of customer
bankAccounts	[BankAccountDTO]	false	List bank accounts of customer
businessUnits	[DefaultBusinessUnitDTO]	false	BU that customer belongs to
custId	string	false	Unique external Customer ID.
customerDepots	[CustomerDepotDTO]	false	List of Depot of customer
customerProducts	[CustomerProductDTO]	false	List of all available services of customer
customerRoles	[CustomerRoleDTO]	false	none
customerType	integer(int32)	false	Customer type, it can be one of the following value: 0 and 1.
defaultAddress	CustomerAddressDTO	false	none
defaultAddressForAddressType	[CustomerAddressDTO]	false	Default Address of customer for each address type
defaultBankAccount	BankAccountDTO	false	Default bank account of customer
description	string	false	none
groupIds	[integer]	false	List of group id that customer is belonging to
groups	[GroupCustomerDTO]	false	none
id	integer(int64)	false	Internal customer ID.
includeCsvReport	boolean	false	Define if csv report is generated for collections requested via files on ftp. The value can be TRUE/FALSE
isBuHasImportedCustomerData	boolean	false	Define if the configured BU has imported customer data. The value can be TRUE/FALSE
isDefaultCustomer	boolean	false	Define if this customer
isImportedFromIT4EM	boolean	false	Define if customer data is imported from IT4EM. The value can be TRUE/FALSE
legacyCustId	string	false	Legacy customer ID.
name	string	true	Customer name
name2	string	false	Customer name 2
payerCustId	string	false	none
status	integer(int32)	false	none
type	string	false	none
parentCustomerId	string	false	External ID of Parent Customer

CustomerDTOV2

Properties

Name	Type	Required	Description
businessUnits	[BusinessUnitDTOV2]	false	none
customerRoles	[CustomerRoleDTOV2]	false	none
defaultAddress	CustomerAddressContactDTOV2	false	none
id	integer(int64)	false	none
isDefaultCustomer	boolean	false	none

CustomerDepotDTO

Properties

Name	Type	Required	Description
geopostDepotNumber	string	false	Depot number
id	integer(int64)	false	internal Product ID in MD
isDefault	integer(int32)	false	Define if a depot is set as default , it can be one of the following value: 0 and 1.

CustomerProductDTO

Properties

Name	Type	Required	Description
additionalProductId	integer(int64)	true	internal Product ID in MD
additionalProductName	string	false	Name of available additional product of above main product.
id	integer(int64)	false	internal Product ID in MD
isRequired	boolean	false	Define if the additional product is required or not. The value can be TRUE/FALSE
mainProductId	integer(int64)	true	internal Product ID in MD
mainProductName	string	false	Name of available main product

CustomerRoleDTO

Properties

Name	Type	Required	Description
description	string	false	none
id	integer(int64)	false	none
roleName	string	false	none

CustomerRoleDTOV2

Properties

Name	Type	Required	Description
id	integer(int64)	false	none

CustomerSupportTokenResponseDTO

Properties

Name	Type	Required	Description
accessToken	string	false	none

CustomerUserProfileDTOV2

Properties

Name	Type	Required	Description
customers	[CustomerDTOV2]	false	none
email	string	false	none
id	integer(int64)	false	none
languageCode	string	false	none
loginName	string	false	none
name	string	false	none
phone	string	false	none
phoneArea	string	false	none
phoneNumber	string	false	none

CustomerValidatorDTOV2

Properties

Name	Type	Required	Description
addressContact	[CustomerAddressValidatorDTOV2]	false	List of customer's address contacts
businessUnits	[BusinessUnitDTOV2]	false	Business Unit which Customer is associated to
custId	string(17)	false	External customer ID
customerProducts	[CustomerProductDTO]	false	List of customer's products
customerType	integer(int32)	false	Type of customer
groupIds	[integer]	false	List of associated groups
id	integer(int64)	false	none
includeCsvReport	boolean	false	Customer profile settings for generating cvs report
name	string	true	Customer's name
name2	string	false	Customer's name 2
parentCustomerId	string(17)	false	External ID of Parent customer

DefaultBusinessUnitDTO

Properties

Name	Type	Required	Description
buCode	string	false	External BU ID per each customer
buConfiguration	BUConfigurationDTO	false	none
buConfigurationId	integer(int64)	false	none
buCountryCode	string	false	Country code alpha-2 (e.g. LV, FR,...) or alpha-3.
buStatus	integer(int32)	false	BU status, it can be one of the following value: 0 and 1.
id	integer(int64)	false	internal BU ID in MD
isDefault	boolean	false	none
legalDisclaimer	string	false	none
name	string	false	BU Name
roleId	integer(int64)	false	none
roleName	string	false	none
sftpConfigs	[SFTPServerConfig]	false	none
supportedLanguages	string	false	none

DefaultBusinessUnitDTOV2

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
isDefault	boolean	false	none
roleId	integer(int64)	false	none

DepotDTO

Properties

Name	Type	Required	Description
address2	string	false	none
address3	string	false	none
addressPostCode	string	false	none
buCode	string	false	none
building	string	false	none
cityName	string	false	none
companyName	string	false	none
companyName2	string	false	none
countryName	string	false	none
countrycode	string	false	none
depotName	string	false	none
depotstr	string	false	none
dummyDepot	string	false	none
fax	string	false	none
floor	string	false	none
geopostDepotnumber	string	false	none
groupId	string	false	none
iataLikeCode	string	false	none
mail	string	false	none
phone	string	false	none
postcode	string	false	none
propNum	string	false	none
sgpsLong	string	false	none
sgpslat	string	false	none
state	string	false	none
street	string	false	none
web	string	false	none

DpdUserDTO

Properties

Name	Type	Required	Description
businessUnits	[DefaultBusinessUnitDTO]	false	none
email	string	false	none
id	integer(int64)	false	none
isBackOfficeAdmin	boolean	false	none
isGroupAdmin	boolean	false	none
ita	string	false	none
languageCode	string	false	none
loginName	string	false	none
name	string	false	none
status	integer(int32)	false	none
username	string	false	none

DpdUserDTOV2

Properties

Name	Type	Required	Description
businessUnits	[DefaultBusinessUnitDTOV2]	false	none
email	string	false	none
id	integer(int64)	false	none
isBackOfficeAdmin	boolean	false	none
languageCode	string	false	none
loginName	string	false	none
name	string	false	none

ElementDTO

Properties

Name	Type	Required	Description
code	string	true	none
id	integer(int64)	false	none
keyElement	boolean	false	none
shortcut	string	true	none
status	integer(int32)	false	none
type	string	true	none
virtual	boolean	false	none

ErrorCodeDTO

Properties

Name	Type	Required	Description
enName	string	false	none
shortCode	string	false	none

ExternalGroupIdCustomerDTO

Properties

Name	Type	Required	Description
buCode	string	false	BU Code which is defined by Geopost.
buId	integer(int64)	false	Internal BU ID which is defined in Master Data.
buName	string	false	Name of BU.
customerId	integer(int64)	false	Internal customer ID which is defined in Master Data.
customerName1	string	false	Customer name 1.
customerName2	string	false	Customer name 2.
externalCustomerId	string	false	External customer ID (get from IT4EM).

ExternalGroupIdGetterDTO

Properties

Name	Type	Required	Description
customers	[ExternalGroupIdCustomerDTO]	false	List of customers of group.
id	integer(int64)	false	Internal group ID in Master Data.
name	string	false	Name of group customer.
type	string	false	Type of Group

GeoWarningDTO

Properties

Name	Type	Required	Description
dataValue	string	false	none
errorCode	ErrorCodeDTO	false	none
sourceObj	string	false	none
sourceStep	string	false	none

GetCustomerUserDTO

Properties

Name	Type	Required	Description
customers	[CustomerDTO]	false	none
defaultAddress	CustomerAddressDTO	false	none
description	string	false	none
email	string	false	none
enableOldDesign	boolean	false	none
expireDate	string	false	none
id	integer(int64)	false	none
isSso	boolean	false	none
ita	string	false	none
languageCode	string	false	none
loginName	string	false	none
name	string	false	none
phone	string	false	none
phoneArea	string	false	none
phoneNumber	string	false	none
status	integer(int32)	false	none
username	string	false	none

GroupCustomerDTO

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
name	string	false	none
type	string	false	none

GroupIdCustomerListDTO

Properties

Name	Type	Required	Description
customers	[GroupIdInternalDTO]	true	none

GroupIdExternalDTO

Properties

Name	Type	Required	Description
buCode	string	false	none
customerId	string	false	none

GroupIdGetAllResponseDTO

Properties

Name	Type	Required	Description
groupIdList	[ExternalGroupIdGetterDTO]	false	List of all groups.
messages	[NstMessage]	false	List of messages.

GroupIdGetterDTO

Properties

Name	Type	Required	Description
customers	[CustomerDTO]	false	none
id	integer(int64)	false	none
name	string	false	none
type	string	false	none

GroupIdGetterResponseDTO

Properties

Name	Type	Required	Description
groupId	ExternalGroupIdGetterDTO	false	none
messages	[NstMessage]	false	none

GroupIdInternalDTO

Properties

Name	Type	Required	Description
buId	integer(int64)	false	none
customerId	integer(int64)	false	none

GroupIdRequestDTO

Properties

Name	Type	Required	Description
customers	[GroupIdInternalDTO]	true	none
name	string	true	none
type	string	true	none

GroupIdRequestExternalDTO

Properties

Name	Type	Required	Description
customers	[GroupIdExternalDTO]	true	none
name	string	true	none
type	string	true	none

GroupIdResponseDTO

Properties

Name	Type	Required	Description
customers	[CustomerDTO]	false	none
id	integer(int64)	false	none
messages	[NstMessage]	false	none
name	string	false	none
type	string	false	none

HiAmountConfigDTO

Properties

Name	Type	Required	Description
currency	string	false	none
isDefault	boolean	false	none
maxAmount	number(double)	false	none

I18nDTO

Properties

Name	Type	Required	Description
appId	integer(int64)	false	none
description	string	false	none
key	string	false	none
languageCode	string	false	none
value	string	false	none

LanguageDTO

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
languageCode	string	true	none
languageName	string	true	none

LinkDTO

Properties

Name	Type	Required	Description
link	string	false	none
name	string	false	none

MasterDataDTO

Properties

Name	Type	Required	Description
appLinks	[AppLinkDTO]	false	none
businessUnitDTOS	[BusinessUnitDTO]	false	none
codPaymentTypes	[CODPaymentTypeDTO]	false	none
countries	[CountryDTO]	false	none
currencies	[CurrencyDTO]	false	none
languages	[LanguageDTO]	false	none
supportedCurrencies	[SupportedCurrencyDTO]	false	none
supportedLanguages	[SupportedLanguageDTO]	false	none

NstMessage

Properties

Name	Type	Required	Description
code	string	false	none
content	string	false	none
field	string	false	none
messageType	string	false	none
params	[string]	false	none

Enumerated Values

Property	Value
messageType	ERROR
messageType	WARNING
messageType	CONFIRM
messageType	INFO

NstResponseDTO

Properties

Name	Type	Required	Description
data	object	false	none
messages	[NstMessage]	false	none

NstResponseDTO_BUConfigurationDTO

Properties

Name	Type	Required	Description
data	BUConfigurationDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_Boolean

Properties

Name	Type	Required	Description
data	boolean	false	none
messages	[NstMessage]	false	none

NstResponseDTO_BudahInstanceDTO

Properties

Name	Type	Required	Description
data	BudahInstanceDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_BusinessUnitDTO

Properties

Name	Type	Required	Description
data	BusinessUnitDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_CityDTO

Properties

Name	Type	Required	Description
data	CityDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_CrCollectionAndRouteResultDTO

Properties

Name	Type	Required	Description
data	CrCollectionAndRouteResultDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_CustomerDTO

Properties

Name	Type	Required	Description
data	CustomerDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_CustomerRoleDTO

Properties

Name	Type	Required	Description
data	CustomerRoleDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_CustomerSupportTokenResponseDTO

Properties

Name	Type	Required	Description
data	CustomerSupportTokenResponseDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_DpdUserDTO

Properties

Name	Type	Required	Description
data	DpdUserDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_GetCustomerUserDTO

Properties

Name	Type	Required	Description
data	GetCustomerUserDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_GroupIdGetterDTO

Properties

Name	Type	Required	Description
data	GroupIdGetterDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_AddressTypeDTO

Properties

Name	Type	Required	Description
data	[AddressTypeDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_ApplicationPermissionDTO

Properties

Name	Type	Required	Description
data	[ApplicationPermissionDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_BusinessUnitDTO

Properties

Name	Type	Required	Description
data	[BusinessUnitDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_CODPaymentTypeDTO

Properties

Name	Type	Required	Description
data	[CODPaymentTypeDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_CurrencyDTO

Properties

Name	Type	Required	Description
data	[CurrencyDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_CustomerDTO

Properties

Name	Type	Required	Description
data	[CustomerDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_DpdUserDTO

Properties

Name	Type	Required	Description
data	[DpdUserDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_ElementDTO

Properties

Name	Type	Required	Description
data	[ElementDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_GetCustomerUserDTO

Properties

Name	Type	Required	Description
data	[GetCustomerUserDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_GroupIdGetterDTO

Properties

Name	Type	Required	Description
data	[GroupIdGetterDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_LanguageDTO

Properties

Name	Type	Required	Description
data	[LanguageDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_ParcelRangeDTO

Properties

Name	Type	Required	Description
data	[ParcelRangeDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_ProductResponseDTO

Properties

Name	Type	Required	Description
data	[ProductResponseDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_ProductSelectionRouteResponseDTO

Properties

Name	Type	Required	Description
data	[ProductSelectionRouteResponseDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_ReasonCodeDTO

Properties

Name	Type	Required	Description
data	[ReasonCodeDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_RoleDTO

Properties

Name	Type	Required	Description
data	[RoleDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_String

Properties

Name	Type	Required	Description
data	[string]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_UserRoleDTO

Properties

Name	Type	Required	Description
data	[UserRoleDTO]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_Long

Properties

Name	Type	Required	Description
data	integer(int64)	false	none
messages	[NstMessage]	false	none

NstResponseDTO_MasterDataDTO

Properties

Name	Type	Required	Description
data	MasterDataDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_ParcelRangeDTO

Properties

Name	Type	Required	Description
data	ParcelRangeDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_ProductResponseOneLevelDTO

Properties

Name	Type	Required	Description
data	ProductResponseDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_RoleDTO

Properties

Name	Type	Required	Description
data	RoleDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_RouteResultDTO

Properties

Name	Type	Required	Description
data	RouteResultDTO	false	none
messages	[NstMessage]	false	none

NstResponseDTO_List_CustomerCustIdsResponseDTOV2

NstResponseDTO_CustomerCustIdsResponseDTOV2

Properties

Name	Type	Required	Description
data	[CustomerCustIdsResponseDTOV2]	false	none
messages	[NstMessage]	false	none

NstResponseDTO_Void

Properties

Name	Type	Required	Description
messages	[NstMessage]	false	none

ParcelRangeDTO

Properties

Name	Type	Required	Description
addressName	string	false	none
applyFor	string	false	none
businessUnits	[DefaultBusinessUnitDTO]	false	none
creationDate	string	false	none
customerId	integer(int64)	false	none
depotNo	string	false	none
id	integer(int64)	false	none
isApplyForBU	boolean	false	none
isImportedFromIT4EM	boolean	false	none
lastUsedNumber	integer(int64)	false	none
legacyId	integer(int64)	false	none
parcelRangeDescription	string	false	none
parcelRangeType	string	true	none
parcelRangeTypeValue	string	false	none
payerCustId	string	false	none
payerName	string	false	none
rangeEnd	integer(int64)	true	none
rangeEndString	string	false	none
rangeStart	integer(int64)	true	none
rangeStartString	string	false	none
rangeType	string	false	none
rcode	string	false	none
senderAddressId	integer(int64)	false	none
senderCustId	string	false	none
senderName	string	false	none
status	integer(int32)	false	none
totalCount	integer(int64)	false	none
updateDate	string	false	none
usedCount	integer(int64)	false	none

Enumerated Values

Property	Value
parcelRangeType	CUSTOMER
parcelRangeType	COLREQ

ParcelRangeDTOV2

Properties

Name	Type	Required	Description
businessUnits	[BusinessUnitDTOV2]	false	none
customerId	integer(int64)	false	none
depotNo	string	false	none
id	integer(int64)	false	none
isApplyForBU	boolean	false	none
parcelRangeType	string	true	none
rangeEnd	integer(int64)	true	none
rangeStart	integer(int64)	true	none
senderAddressId	integer(int64)	false	none

Enumerated Values

Property	Value
parcelRangeType	CUSTOMER
parcelRangeType	COLREQ

PasswordDTO

Properties

Name	Type	Required	Description
newPassword	string	true	none
oldPassword	string	true	none
userId	integer(int64)	true	none

PatchUserRequestDTO

Properties

Name	Type	Required	Description
languageCode	string	false	none

ProductResponseDTO

Properties

Name	Type	Required	Description
additionalProducts	[ProductResponseDTO]	false	none
additionalProductsOneLevel	[ProductResponseDTO]	false	none
businessUnits	[DefaultBusinessUnitDTO]	false	none
collectionRequest	boolean	false	none
description	string	false	none
displayOnLabel	boolean	false	none
elementCodes	string	false	none
elementCount	integer(int32)	false	none
elements	[ElementDTO]	false	none
id	integer(int64)	false	none
isMandatoryDimension	boolean	false	none
isMandatoryWeight	boolean	false	none
mainProductType	integer(int32)	false	none
mainProducts	[ProductResponseDTO]	false	none
mandatoryProducts	[ProductResponseDTO]	false	none
mpsOption	integer(int32)	false	none
name	string	false	none
notAllowMPS	boolean	false	none
serviceType	integer(int32)	false	none
shippingRestrictions	[ShippingRestrictionDTO]	false	none
swapBackElements	[ElementDTO]	false	none
translations	[TranslationDTO]	false	none
type	integer(int32)	false	none

ProductSelectionRouteResponseDTO

Properties

Name	Type	Required	Description
asCode	string	false	none
asCodeElements	[string]	false	none
buCode	string	false	none
csort	string	false	none
dcountry	string	false	none
ddepot	string	false	none
ddgroup	string	false	none
dsort	string	false	none
ocountry	string	false	none
odgroup	string	false	none
osort	string	false	none
soCode	string	false	none
soCodeElements	[string]	false	none
ssort	string	false	none
zdPostCode	string	false	none

ReasonCodeDTO

Properties

Name	Type	Required	Description
description	string	false	none
reasonCode	string	false	none

CustomerCustIdsResponseDTOV2

Properties

Name	Type	Required	Description
customerId	string	false	none

ResponseEntity

Properties

Name	Type	Required	Description
body	object	false	none
statusCode	string	false	none
statusCodeValue	integer(int32)	false	none

Enumerated Values

Property	Value
statusCode	100 CONTINUE
statusCode	101 SWITCHING_PROTOCOLS
statusCode	102 PROCESSING
statusCode	103 CHECKPOINT
statusCode	200 OK
statusCode	201 CREATED
statusCode	202 ACCEPTED
statusCode	203 NON_AUTHORITATIVE_INFORMATION
statusCode	204 NO_CONTENT
statusCode	205 RESET_CONTENT
statusCode	206 PARTIAL_CONTENT
statusCode	207 MULTI_STATUS
statusCode	208 ALREADY_REPORTED
statusCode	226 IM_USED
statusCode	300 MULTIPLE_CHOICES
statusCode	301 MOVED_PERMANENTLY
statusCode	302 FOUND
statusCode	302 MOVED_TEMPORARILY
statusCode	303 SEE_OTHER
statusCode	304 NOT_MODIFIED
statusCode	305 USE_PROXY
statusCode	307 TEMPORARY_REDIRECT
statusCode	308 PERMANENT_REDIRECT
statusCode	400 BAD_REQUEST
statusCode	401 UNAUTHORIZED
statusCode	402 PAYMENT_REQUIRED
statusCode	403 FORBIDDEN
statusCode	404 NOT_FOUND
statusCode	405 METHOD_NOT_ALLOWED
statusCode	406 NOT_ACCEPTABLE
statusCode	407 PROXY_AUTHENTICATION_REQUIRED
statusCode	408 REQUEST_TIMEOUT
statusCode	409 CONFLICT
statusCode	410 GONE
statusCode	411 LENGTH_REQUIRED
statusCode	412 PRECONDITION_FAILED
statusCode	413 PAYLOAD_TOO_LARGE
statusCode	413 REQUEST_ENTITY_TOO_LARGE
statusCode	414 URI_TOO_LONG
statusCode	414 REQUEST_URI_TOO_LONG
statusCode	415 UNSUPPORTED_MEDIA_TYPE
statusCode	416 REQUESTED_RANGE_NOT_SATISFIABLE
statusCode	417 EXPECTATION_FAILED
statusCode	418 I_AM_A_TEAPOT
statusCode	419 INSUFFICIENT_SPACE_ON_RESOURCE
statusCode	420 METHOD_FAILURE
statusCode	421 DESTINATION_LOCKED
statusCode	422 UNPROCESSABLE_ENTITY
statusCode	423 LOCKED
statusCode	424 FAILED_DEPENDENCY
statusCode	425 TOO_EARLY
statusCode	426 UPGRADE_REQUIRED
statusCode	428 PRECONDITION_REQUIRED
statusCode	429 TOO_MANY_REQUESTS
statusCode	431 REQUEST_HEADER_FIELDS_TOO_LARGE
statusCode	451 UNAVAILABLE_FOR_LEGAL_REASONS
statusCode	500 INTERNAL_SERVER_ERROR
statusCode	501 NOT_IMPLEMENTED
statusCode	502 BAD_GATEWAY
statusCode	503 SERVICE_UNAVAILABLE
statusCode	504 GATEWAY_TIMEOUT
statusCode	505 HTTP_VERSION_NOT_SUPPORTED
statusCode	506 VARIANT_ALSO_NEGOTIATES
statusCode	507 INSUFFICIENT_STORAGE
statusCode	508 LOOP_DETECTED
statusCode	509 BANDWIDTH_LIMIT_EXCEEDED
statusCode	510 NOT_EXTENDED
statusCode	511 NETWORK_AUTHENTICATION_REQUIRED

RoleApplicationDTO

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
name	string	false	none
permissions	[ApplicationPermissionDTO]	false	none
type	string	false	none

RoleDTO

Properties

Name	Type	Required	Description
applications	[RoleApplicationDTO]	false	none
description	string	false	none
id	integer(int64)	false	none
roleName	string	false	none

RouteResultDTO

Properties

Name	Type	Required	Description
asCode	string	false	none
barcodeId	string	false	none
barcodePostcode	string	false	none
buAlphaStr	string	false	none
buCode	string	false	none
cSort	string	false	none
dCountry	string	false	none
dDepot	string	false	none
dDepotCountry	string	false	none
dDepotStr	string	false	none
dSort	string	false	none
networkCode	string	false	none
oSort	string	false	none
partnerCode	string	false	none
sSort	string	false	none
serviceMark	string	false	none
serviceText	string	false	none
soCode	string	false	none
version	string	false	none

SFTPServerConfig

Properties

Name	Type	Required	Description
buId	integer(int64)	false	none
configType	string	false	none
host	string	false	none
localPath	string	false	none
password	string	false	none
port	integer(int32)	false	none
privateKey	string	false	none
sectionName	string	false	none
serverPath	string	false	none
username	string	false	none

ShippingRestrictionDTO

Properties

Name	Type	Required	Description
fromCode	string (20)	true	none
fromName	string (200)	true	none
restrictionToList	restrictionToList	true	none
zipCodeRestrictionList	zipCodeRestrictionList	false	none

CountryRestrictionToDTO

Properties

Name	Type	Required	Description
toName	string (20)	true	Country code which shipment shipping to
toCode	string (200)	true	Country name which shipment shipping to

ZipCodeRestrictionDTO

Properties

Name	Type	Required	Description
fromRange	string (9)	true	none
toRange	string (9)	true	none

SupportedCurrencyDTO

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
supportedCurrencyCode	string	true	none
supportedCurrencyName	string	true	none
symbol	string	false	none

SupportedLanguageDTO

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
supportedLanguageCode	string	true	none
supportedLanguageName	string	true	none

TranslationDTO

Properties

Name	Type	Required	Description
description	string	false	none
id	integer(int64)	false	none
languageCode	string	false	none
name	string	false	none
productId	integer(int64)	false	none

UpdateBUSystemUsedStatusDTO

Properties

Name	Type	Required	Description
appName	string	false	none
used	boolean	false	none

UpdateBusinessUnitStatusDTO

Properties

Name	Type	Required	Description
active	boolean	false	none

UserRoleDTO

Properties

Name	Type	Required	Description
objectType	string	false	none
permissions	[string]	false	none

UpsertAddressRequestDTO

Properties

Name	Type	Required	Restrictions	Description
addressList	[UpsertAddressContactDTO]	false	none	List of addresses

UpsertAddressContactDTO

Properties

Name	Type	Required	Restrictions	Description
addressEventId	long(12)	Yes	none	ID for request tracking. Need to copy this value from Request and puts in Response.
addressId	long(8)	Yes	none	Unique customer's address ID in IT4EM.
city	string(35)	No	none	City.
contactName	string(35)	No	none	Contact name.
countryCode	string(3)	Yes	none	Country code alpha-2 (e.g. LV, FR,...) or alpha-3.
customerId	string(17)	Yes	none	Unique Customer ID which will be used in the provided BU.
defaultFlag	boolean	Yes	none	Define if it's default address. The value can be TRUE/FALSE TRUE: default address FALSE: normal address
depotNo	string(7)	Yes	none	Depot number of current address.
email	string(100	No	none	Email address.
flatNo	string(8)	No	none	Flat number.
houseNo	string(20)	No	none	House number.
legacyID	string(20)	Yes	none	Legacy customer ID.
name	string(35)	Yes	none	Customer name in current address.
name2	string(35)	No	none	Customer name 2 in current address.
parentCustomerId	string(17)	No	none	Unique parentCustomer ID which will be used in the provided BU.
parentId	integer(int64)	false	none	none
phone	string(26)	No	none	Phone number.
phonePrefix	string(4)	No	none	Phone prefix.
street	string	false	none	none
town	string(35)	Yes	none	Region.
type	integer(1)	Yes	none	Type of address, it can be one of the following value: 0, 1, 2, 3, 4, 5, 6, 7. In which: 0: Pickup 1: Legal 2: Home 3: Invoice 4: Location 5: Debit 6: TI / HB 7: Return
zipCode	string(9)	Yes	none	Zip code.
DELIS_USER_ID	string(50)	No	none	Customer ID to be used by BUs. Currently in use by DPD CZ for DelisID.

CustomerAddressResponseDTO

Properties

Name	Type	Required	Restrictions	Description
addressResults	[AddressResultDTO]	Yes	none	List of responses of request.
transactionId	long	Yes	none	ID for request tracking

AddressResultDTO

Properties

Name	Type	Required	Restrictions	Description
addressEventId	long	Yes	none	ID for request tracking. Need to copy this value from Request and puts in Response.
errorList	[EONstMessage]	Yes	none	List of errors returned.

EONstMessage

Properties

Name	Type	Required	Restrictions	Description
errorCode	string	Yes	none	Error code.
errorField	string	No	none	The field has error.
errorText	string	Yes	none	Explanation if there was an error in process