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
ApiRequestOfModelAPIReturnNotificationCreateName | 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
ModelAPIReturnNotificationName | 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": "ec13c4bb-10b8-41fe-9fea-6a8eb67e2b8c", "Reference": "sample string 3", "Packs": 4, "Warehouse": "sample string 5", "PointID": 6, "ShipmentID": "sample string 7", "DateCreated": "2021-01-10T05:38:56+01:00", "DateReceived": "2021-01-10T05:38:56+01:00", "DateCancelled": "2021-01-10T05:38:56+01:00", "IsError": true, "ErrorMessage": "sample string 12", "ErrorID": "sample string 13" }