[1.23.0] Place of cost creation (MPK)
Warning!
Resource is available only in: PL, IT
For the purposes of cost settlements, you can use the COD Report. MPK Resource - place of cost creation - dictionary value defined by user means, e.g: organization department which generated the cost (sent the parcel) - marketing department, logistics department, etc.
It could be freely defined, but should be unique. MPK is assigned to a parcel and even after the change of the MPK name, it cannot change in the historical data.
On this page
Structure
Resource MPK
has attributes:
| Integer | Unique id. | PL, IT |
| String | Place of cost creation name. | PL, IT |
| String | Place of cost creation description. | PL, IT |
| DateTime | Last update. | PL, IT |
| DateTime | Creation date. | PL, IT |
Example:
1
2
3
4
5
6
7
8
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
"id": 1,
"name": "Place of cost creation name.",
"description": "Place of cost creation description",
"created_at": "2018-05-15T21:58:49.427+02:00",
"updated_at": "2018-05-17T10:35:59.644+02:00"
}
Authorization
Access to resource requires correct and valid access token.
List of MPK
Resource is paged.
1
GET /v1/organizations/:organization_id/mpks
Sorting
| Attribute by which list will be sorted | PL, IT |
| Default: | PL, IT |
Request example
1
curl -X GET https://api-shipx-pl.easypack24.net/v1/organizations/1/mpks -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "http://api-shipx-pl.easypack24.net:3000/v1/organizations/1/mpks",
"count": 3,
"page": 1,
"per_page": 30,
"items": [
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/3",
"id": 3,
"name": "First",
"description": "Some New Description 1",
"created_at": "2018-05-16T13:36:28.332+02:00",
"updated_at": "2018-05-16T13:36:28.332+02:00"
},
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/2",
"id": 2,
"name": "Second",
"description": "Some New Description 2",
"created_at": "2018-05-16T13:33:03.745+02:00",
"updated_at": "2018-05-17T09:56:11.500+02:00"
},
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
"id": 1,
"name": "Third",
"description": "Some New Description 3",
"created_at": "2018-05-15T21:58:49.427+02:00",
"updated_at": "2018-05-15T22:31:04.316+02:00"
}
]
}
Details of MPK
1
GET /v1/mpks/:id
Request example
1
curl -X GET https://api-shipx-pl.easypack24.net/v1/mpks/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
Response
1
2
3
4
5
6
7
8
9
10
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
"id": 1,
"name": "Nowa nazwa miejsca powstania kosztów",
"description": "Nowy opis miejsca powstania kosztów",
"created_at": "2018-05-15T21:58:49.427+02:00",
"updated_at": "2018-05-15T22:31:04.316+02:00"
}
Details of MPK
1
GET /v1/mpks/:id
Request example
1
curl -X GET https://api-shipx-pl.easypack24.net/v1/mpks/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json'
Response
1
2
3
4
5
6
7
8
9
10
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
"id": 1,
"name": "Nowa nazwa miejsca powstania kosztów",
"description": "Nowy opis miejsca powstania kosztów",
"created_at": "2018-05-15T21:58:49.427+02:00",
"updated_at": "2018-05-15T22:31:04.316+02:00"
}
Creation of MPK
1
POST /v1/organizations/:organization_id/mpks
Parameters
| String | MPK name |
| PL, IT |
| String | MPK description |
| PL, IT |
Request example
1
2
3
4
curl -X PUT https://api-shipx-pl.easypack24.net/v1/organizations/1/mpks -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{
"name": "MPK name",
"description": "MPK description"
}'
Response
1
2
3
4
5
6
7
8
9
10
HTTP/1.1 201 Created
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/3",
"id": 3,
"name": "MPK name",
"description": "MPK description",
"created_at": "2018-05-16T13:36:28.332+02:00",
"updated_at": "2018-05-16T13:36:28.332+02:00"
}
List of error keys that may occur:
resource_not_found
- organization with this ID does not exist
Updating of MPK
1
PUT /v1/mpks/:id
Parameters
| String | MPK name |
| PL, IT |
| String | MPK description |
| PL, IT |
Request example
1
2
3
4
curl -X PUT https://api-shipx-pl.easypack24.net/v1/mpks/1 -H 'Authorization: Bearer token' -H 'Content-Type: application/json' -d '{
"name": "MPK name",
"description": "MPK description"
}'
Response
1
2
3
4
5
6
7
8
9
10
HTTP/1.1 200 OK
Content-Type: application/json
{
"href": "https://api-shipx-pl.easypack24.net/v1/mpks/1",
"id": 1,
"name": "MPK name",
"description": "MPK description",
"created_at": "2018-05-15T21:58:49.427+02:00",
"updated_at": "2018-05-17T10:35:59.644+02:00"
}
List of error keys that may occur:
resource_not_found
- webhook with the given ID does not exist