Overview
The service returns list of serial numbers for a given product id. If the requested product id is shadow the serial numbers for its shadow parent will be returned.
Endpoint
For the TT server, this endpoint will be: https://tt.api.sellercloud.com/rest/api/Inventory/GetSerialNumbers
For your server, this endpoint will be: https://{your_server_id}.api.sellercloud.com/rest/api/Inventory/GetSerialNumbers
Request
- ProductID – id of the product of which to get serial numbers [Required]
- SerialNumber – filter results on serial number [Optional]
- WarehouseID – filter results on warehouse id [Optional]
- InstockOnly – filter results on in stock [Optional]. Default is false.
- ReceivedOnFromDate – filter results on received on from date [Optional]
- ReceivedOnToDate – filter results on received on to date [Optiona]
- PageNumber – page number of the retrieved serial numbers [Optional]. Default is 1.
- PageSize – page size of the retrieved serial numbers [Optional]. Default is 10.
Request Example
- Method Type: HttpPost
- Authorization: Use Bearer Token + token received from token authentication
- Header info: Content-Type: application/json
{
"ProductID": "string",
"SerialNumber": "string",
"WarehouseID": 0,
"InstockOnly": true,
"ReceivedOnFromDate": "2021-09-01T12:17:39.632Z",
"ReceivedOnToDate": "2021-09-01T12:17:39.632Z",
"PageNumber": 0,
"PageSize": 0
}
Response
{
"ProductID": "string",
"SerialNumbers": [
{
"SerialNumber": "string",
"PurchaseID": 0,
"OrderID": 0,
"OrderItemID": 0,
"CreditMemoID": 0,
"CreditMemoReason": "string",
"WarehouseID": "string",
"BinName": "string",
"FBAShipmentID": 0,
"WarehouseTransferRequestID": 0,
"ExpiryDate": "2021-09-01T12:17:39.631Z",
"ReceivedOn": "2021-09-01T12:17:39.631Z"
}
],
"TotalSerialNumbers": 0
}
- ProductID – the prodoct ID for which serial numbers are returned.
- SerialNumbers – list of the serial numbers page
- TotalSerialNumbers – total serial numbers count