POST v1/GoodsReceipt/{id}/Confirm
Confirms a shipment
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The unique internal identifier of the goods receipt in Tradevine e.g. 3451582911567846854 |
integer |
Optional |
Body Parameters
The goods receipt data to update
Name | Description | Type |
---|---|---|
GoodsReceiptID |
The unique internal identifier of each goods receipt in Tradevine e.g. 345158291152342534 |
integer |
OrganisationID |
The internal identifier of this organisation in Tradevine e.g. 3451460443781171981 |
integer |
PurchaseOrderID |
The unique internal identifier of each purchase order in Tradevine e.g. 34515829115774435643 |
integer |
Status |
The order status lookup value |
integer |
GoodsReceiptNumber |
The more user friendly identifier for the goods-receipt (auto-generated from the purchase order number) e.g. PO783/1 |
string |
DeliveryAddressID |
The internal identifier of your address in Tradevine for delivery e.g. your warehouse address 3451460547437456 |
integer |
SupplierReference |
An external reference from your supplier that may have come in with the shipment |
string |
ReceiptDate |
The date and time (in UTC) that the order was received in (confirmed the goods receipt) |
date |
CreatedDate |
The date and time (in UTC) that the order was created |
date |
CreatedBy |
The internal Tradevine ID of the user that created the order |
integer |
ModifiedDate |
The date and time (in UTC) that the order was last modified |
date |
ModifiedBy |
The internal Tradevine ID of the user that last modified the order |
integer |
WarehouseID |
The internal Tradevine ID of the warehouse that the incoming stock will be incremented with |
integer |
GoodsReceiptItems | Collection of GoodsReceiptItem |
Request Formats
application/json
Sample:
{ "GoodsReceiptID": 1, "OrganisationID": 1, "PurchaseOrderID": 1, "Status": 1, "GoodsReceiptNumber": "sample string 1", "DeliveryAddressID": 1, "SupplierReference": "sample string 2", "ReceiptDate": "2024-10-05T19:17:12.4773293+13:00", "CreatedDate": "2024-10-05T19:17:12.4773293+13:00", "CreatedBy": 1, "ModifiedDate": "2024-10-05T19:17:12.4773293+13:00", "ModifiedBy": 1, "WarehouseID": 1, "GoodsReceiptItems": [ { "GoodsReceiptItemID": 1, "GoodsReceiptID": 1, "OrganisationID": 1, "ProductID": 1, "Code": "sample string 1", "LineNumber": 1, "QuantityRequired": 1.0, "QuantityReceived": 1.0, "QuantityBackOrder": 1.0, "CreatedDate": "2024-10-05T19:17:12.4773293+13:00", "CreatedBy": 1, "ModifiedDate": "2024-10-05T19:17:12.4773293+13:00", "ModifiedBy": 1 }, { "GoodsReceiptItemID": 1, "GoodsReceiptID": 1, "OrganisationID": 1, "ProductID": 1, "Code": "sample string 1", "LineNumber": 1, "QuantityRequired": 1.0, "QuantityReceived": 1.0, "QuantityBackOrder": 1.0, "CreatedDate": "2024-10-05T19:17:12.4773293+13:00", "CreatedBy": 1, "ModifiedDate": "2024-10-05T19:17:12.4773293+13:00", "ModifiedBy": 1 } ] }
Response Information
Resource Description
The goods receipt data from the Tradevine database
Name | Description | Type |
---|---|---|
GoodsReceiptID |
The unique internal identifier of each goods receipt in Tradevine e.g. 345158291152342534 |
integer |
OrganisationID |
The internal identifier of this organisation in Tradevine e.g. 3451460443781171981 |
integer |
PurchaseOrderID |
The unique internal identifier of each purchase order in Tradevine e.g. 34515829115774435643 |
integer |
Status |
The order status lookup value |
integer |
GoodsReceiptNumber |
The more user friendly identifier for the goods-receipt (auto-generated from the purchase order number) e.g. PO783/1 |
string |
DeliveryAddressID |
The internal identifier of your address in Tradevine for delivery e.g. your warehouse address 3451460547437456 |
integer |
SupplierReference |
An external reference from your supplier that may have come in with the shipment |
string |
ReceiptDate |
The date and time (in UTC) that the order was received in (confirmed the goods receipt) |
date |
CreatedDate |
The date and time (in UTC) that the order was created |
date |
CreatedBy |
The internal Tradevine ID of the user that created the order |
integer |
ModifiedDate |
The date and time (in UTC) that the order was last modified |
date |
ModifiedBy |
The internal Tradevine ID of the user that last modified the order |
integer |
WarehouseID |
The internal Tradevine ID of the warehouse that the incoming stock will be incremented with |
integer |
GoodsReceiptItems | Collection of GoodsReceiptItem |
Response Formats
application/json
Sample:
{ "GoodsReceiptID": 1, "OrganisationID": 1, "PurchaseOrderID": 1, "Status": 1, "GoodsReceiptNumber": "sample string 1", "DeliveryAddressID": 1, "SupplierReference": "sample string 2", "ReceiptDate": "2024-10-05T19:17:12.4929507+13:00", "CreatedDate": "2024-10-05T19:17:12.4929507+13:00", "CreatedBy": 1, "ModifiedDate": "2024-10-05T19:17:12.4929507+13:00", "ModifiedBy": 1, "WarehouseID": 1, "GoodsReceiptItems": [ { "GoodsReceiptItemID": 1, "GoodsReceiptID": 1, "OrganisationID": 1, "ProductID": 1, "Code": "sample string 1", "LineNumber": 1, "QuantityRequired": 1.0, "QuantityReceived": 1.0, "QuantityBackOrder": 1.0, "CreatedDate": "2024-10-05T19:17:12.4929507+13:00", "CreatedBy": 1, "ModifiedDate": "2024-10-05T19:17:12.4929507+13:00", "ModifiedBy": 1 }, { "GoodsReceiptItemID": 1, "GoodsReceiptID": 1, "OrganisationID": 1, "ProductID": 1, "Code": "sample string 1", "LineNumber": 1, "QuantityRequired": 1.0, "QuantityReceived": 1.0, "QuantityBackOrder": 1.0, "CreatedDate": "2024-10-05T19:17:12.4929507+13:00", "CreatedBy": 1, "ModifiedDate": "2024-10-05T19:17:12.4929507+13:00", "ModifiedBy": 1 } ] }