Overview
This endpoint can be used to get data for multiple shipping containers
In order to consume the endpoint you must:
- Be authenticated user
For information on how you can authenticate, see: Authentication
As soon as you do authentication and receive a valid token, it needs to be passed to the call.
Endpoint
Example for such endpoint for TT server is:
https://tt.api.sellercloud.com/rest/api/ShippingContainers
For your server endpoint will be:
https://{your_server_id}.api.sellercloud.com/rest/api/ShippingContainers
Request
- Method Type: HttpGet
- Authorization: Use Bearer Token + token received from token authentication
Query Parameters:
| Parameter | Data Type | Description | Is Required |
| containerIds | Array[int] | Filter by container ids | No |
| containerNames | Array[string] | Filter by container names | No |
| vendorIds | Array[int] | Filter by vendor ids | No |
| poIds | Array[int] | Filter by purchase order ids | No |
| productIds | Array[string] | Filter by product ids | No |
| warehouseIds | Array[int] | Filter by warehouse ids | No |
| pageNumber | Integer | Page number | No |
| pageSize | Integer | Page size | No |
Response
- If user is authenticated and the request is successful, then response will be Status Code 200 => OKwith json in the response body containing information about the found shipping containers
- If user is not authenticated, then response will be Status Code 401 => Not Valid Token
- In case of error, response will be Status Code 500 => Internal Server Error
{
{
"Items": [
{
"ID": 0,
"ContainerName": "string",
"CreatedOn": "2022-08-01T09:10:12.878Z",
"ShippedOn": "2022-08-01T09:10:12.878Z",
"IsExported": true,
"Notes": "string",
"EstimatedArrivalDate": "2022-08-01T09:10:12.878Z",
"ReceivedDate": "2022-08-01T09:10:12.878Z",
"ETAPort": "2022-08-01T09:10:12.878Z",
"PortName": "string",
"ShippingCost": 0,
"ImportTaxesTotal": 0,
"ImportTaxesPerDollar": 0,
"ImportFrieightTotal": 0,
"ImportFrieghtPerDollar": 0,
"ImportTariffTotal": 0,
"ImportDutyTotal": 0,
"VesselNumber": "string",
"InvoiceNumber": "string",
"OrderSourceSPONumber": "string",
"TotalReceived": 0,
"TotalQty": 0,
"TotalCost": 0,
"VendorID": 0,
"CompanyID": 0,
"ReceivingWarehouse": "string",
"CReceivedDate": "2022-08-01T09:10:12.878Z",
"VendorName": "string",
"IsExportedString": "string",
"ShippingStatus": 0,
"ContainerStatus": 0,
"ClientID": 0,
"ReceivingWarehouseID": 0,
"ReceivingWarehouseBinID": 0
}
],
"TotalResults": 0
}