PATCH api/stockitems/{id}
Edits a given record. Not specified fields are kept as before.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
StockItemVMName | Description | Type | Additional information |
---|---|---|---|
T_ID |
Transteams unique record ID (Key) |
integer |
None. |
C_ID |
The Customers unique record ID |
integer |
Required |
OwnerID |
OwnerID may be ommitted in transfered JSON Record; otherwise it is ignored. OwnerID is derived from login identity. |
integer |
None. |
Ship |
The ships name |
string |
Max length: 50 |
Supplier |
The suppliers name |
string |
Required Max length: 40 |
OrderNo |
The suppliers (or customers) number (ID) unique per order |
string |
Required Max length: 40 |
Quantity |
Quantity of items |
integer |
Required Range: inclusive between 1 and 2147483647 |
Item |
The items name or description in english |
string |
Required Max length: 40 |
Item_German |
The items name or description in german |
string |
Max length: 40 |
Value |
Value of item(s) in Euro |
decimal number |
None. |
Weight | decimal number |
None. |
|
Length | decimal number |
None. |
|
Width | decimal number |
None. |
|
Height | decimal number |
None. |
|
AvisDate |
Date/Time of record creation at Transteam. Ignored if posted, but added to the record sent in the response body. |
date |
None. |
StockDate |
Date/time of arrival at Transteam stock. Read only; ignored if posted. |
date |
None. |
Status |
Internal Transteam Value; ignored if posted |
string |
Max length: 1 |
HasPDF |
If true there is a PDF downloadable at api/Documents/{T_ID} |
boolean |
None. |
DG |
Dangerous goods classification |
boolean |
None. |
Customs_Status |
For customers use; not used by Transteam |
string |
Max length: 3 |
Vessel_IMO_No |
The vessels IMO number |
integer |
Required |
TrackingNo |
For customers use; not used by Transteam |
string |
Required Max length: 40 |
OriginCountry | string |
Max length: 20 |
|
ExpectedArrival |
currently not used |
date |
None. |
Request Formats
application/json, text/json
{ "T_ID": 1, "C_ID": 1, "OwnerID": 1, "Ship": "sample string 2", "Supplier": "sample string 3", "OrderNo": "sample string 4", "Quantity": 5, "Item": "sample string 6", "Item_German": "sample string 7", "Value": 1.0, "Weight": 1.1, "Length": 1.1, "Width": 1.1, "Height": 1.1, "AvisDate": "2025-05-22T15:18:51.1375172+02:00", "StockDate": "2025-05-22T15:18:51.1375172+02:00", "Status": "sample string 8", "HasPDF": true, "DG": true, "Customs_Status": "sample string 9", "Vessel_IMO_No": 1, "TrackingNo": "sample string 10", "OriginCountry": "sample string 11", "ExpectedArrival": "2025-05-22T15:18:51.1375172+02:00" }
application/xml, text/xml
<StockItemVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TTWebAPI.ViewModels"> <AvisDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <d2p1:DateTime>2025-05-22T13:18:51.1375172Z</d2p1:DateTime> <d2p1:OffsetMinutes>120</d2p1:OffsetMinutes> </AvisDate> <C_ID>1</C_ID> <Customs_Status>sample string 9</Customs_Status> <DG>true</DG> <ExpectedArrival>2025-05-22T15:18:51.1375172+02:00</ExpectedArrival> <HasPDF>true</HasPDF> <Height>1.1</Height> <Item>sample string 6</Item> <Item_German>sample string 7</Item_German> <Length>1.1</Length> <OrderNo>sample string 4</OrderNo> <OriginCountry>sample string 11</OriginCountry> <OwnerID>1</OwnerID> <Quantity>5</Quantity> <Ship>sample string 2</Ship> <Status>sample string 8</Status> <StockDate>2025-05-22T15:18:51.1375172+02:00</StockDate> <Supplier>sample string 3</Supplier> <T_ID>1</T_ID> <TrackingNo>sample string 10</TrackingNo> <Value>1</Value> <Vessel_IMO_No>1</Vessel_IMO_No> <Weight>1.1</Weight> <Width>1.1</Width> </StockItemVM>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
The updated stockitem
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |