Overview
To receive a purchase order using the API you can consume the endpoint presented in this article. To consume it, you must:
- Be authenticated user
For information on how you can authenticate, see: Authentication
Endpoint
Example for such endpoint for TT server is:
https://tt.api.sellercloud.com/rest/api/PurchaseOrders/{purchaseOrderId}/receive
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/PurchaseOrders/{purchaseOrderId}/receive
Request
- Method Type: HttpPost
- Authorization: Bearer Token – use token received from authentication
- Header info: Content-Type: application/json
- Parameters:
| Parameter | Data Type | Description | Is Required |
| id | integer | Id of the Purchase Order | Yes |
| model | {
“ReceiveInvoiceNumber”: “string”, “VendorOrderId”: “string”, “ShippingCost”: 0, “Items”: [ { “ID”: 0, “QtyToReceive”: 0, “CaseQtyToReceive”: 0, “WarehouseId”: 0, “WarehouseBinId”: 0, “UnitPrice”: 0, “DiscountValue”: 0, “DiscountType”: “FixedAmount”, “LocationNotes”: “string”, “ListPrice”: 0, “UPC”: “string”, “WeightLbs”: 0, “WeightOz”: 0 } ] } |
– ReceiveInvoiceNumber – invoice number for the purchase order receiving (optional)
– VendorOrderId – vendor order id for the purchase order receiving (optional) – ShippingCost – shipping cost for the purchase order receiving (optional) – Items – list with items to receive (required) – Item.ID – id of the purchase order item (required) – Item.QtyToReceive – should be used to specify how many items to receive when the PO is in non case qty mode (optional) – Item.CaseQtyToReceive – should be used to specify how many cases with items to receive when the PO is in case qty mode (optional) – Item.WarehouseId – id of the warehouse in which the item is received. If not provided the warehouse set during the PO creation for this item will be used (optional) – Item fields WarehouseBinId, UnitPrice, DiscountValue, DiscountType, LocationNotes, ListPrice, UPC, WeightLbs, WeightOz are all optional and can be used to set additional information when receiving an item. There are client settings that control whether or not this information can be set. If value is provided for a field that cannot be updated a 404 BadRequest is returned with detailed information about the client setting that is forbidding the update. – Item.DiscountType possible values are: “FixedAmount” and “Percentage” – All fields are nullable and they can be either ommited or null has to be provided in case no value is passed to them. |
Yes |
Important:
Additional actions that have to be done after a PO is received:
– the shipment reserves have to be updated if there is a related FBA shipment to the PO
– serial numbers have to be entered If the product that is being received requires serial number scanning
Response
- 200 OK – request is processed successfully
- 401 Not Authorized – token is missing or is not valid
- 400 Bad Request – invalid request parameters
- 500 Internal Server Error – unexpected error