POST api/v{version}/ecommerce/returnshipment/notification/create
Create a Returnshipment notification
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| version | string |
None. |
Body Parameters
ApiRequestOfModelAPIReturnNotificationCreate| Name | Description | Type | Additional information |
|---|---|---|---|
| data | ModelAPIReturnNotificationCreate |
Required |
|
| client_id | string |
Required |
|
| auth_token | string |
Required |
|
| ts | string |
Required |
Request Formats
application/json, text/json
Sample:
{
"data": {
"Reference": "sample string 1",
"Warehouse": "sample string 2",
"Packs": 3
},
"client_id": "sample string 1",
"auth_token": "sample string 2",
"ts": "sample string 3"
}
Response Information
Resource Description
ModelAPIReturnNotification
ModelAPIReturnNotification| Name | Description | Type | Additional information |
|---|---|---|---|
| ID | globally unique identifier |
None. |
|
| Reference | string |
None. |
|
| Packs | integer |
None. |
|
| Warehouse | string |
None. |
|
| PointID | integer |
None. |
|
| ShipmentID | string |
None. |
|
| DateCreated | date |
None. |
|
| DateReceived | date |
None. |
|
| DateCancelled | date |
None. |
|
| IsError | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| ErrorID | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ID": "bdfe5134-061e-4415-8307-b7ae04a23772",
"Reference": "sample string 3",
"Packs": 4,
"Warehouse": "sample string 5",
"PointID": 6,
"ShipmentID": "sample string 7",
"DateCreated": "2020-01-27T18:01:44+01:00",
"DateReceived": "2020-01-27T18:01:44+01:00",
"DateCancelled": "2020-01-27T18:01:44+01:00",
"IsError": true,
"ErrorMessage": "sample string 12",
"ErrorID": "sample string 13"
}