cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/shipment-notices?page=1&size=100&sortBy=createdAt&sortDirection=DESC' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/shipment-notices"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/shipment-notices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "SUBMITTED",
"sourceType": "SUPPLIER",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"shipmentNoticeOrderItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendorSku": "<string>",
"vendorCode": "<string>",
"categoryCode": "<string>",
"productTitle": "<string>"
},
"status": "EXPECTED",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"quantity": 123,
"description": "<string>"
}
],
"shipmentNoticePackages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"shipmentNoticePackageItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"inventories": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"deployStatus": "AWAITING_ARRIVAL",
"serialNumber": "SN123456789",
"warehouse": null
}
],
"status": "EXPECTED",
"expectedQuantity": 123,
"receivedQuantity": 123,
"skuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendorSku": "<string>"
}
],
"status": "PENDING",
"trackingCode": "<string>",
"shippingCarrier": "<string>",
"trackingUrl": "<string>"
}
],
"condition": "NEW",
"purchaseOrderNumber": "<string>",
"expectedShipDate": "2023-12-25",
"submittedBy": null
}
]{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Shipment Notices
List shipment notices
Returns a paginated list of shipment notice orders. V1 exposes a full inventories list per package item, replacing the single serial-number field in the legacy endpoint. Supports filtering by status, warehouse, and date range.
GET
https://apipub.firstbasehq.com
/
api
/
v1
/
shipment-notices
cURL
curl -sS -X GET 'https://apipub.firstbasehq.com/api/v1/shipment-notices?page=1&size=100&sortBy=createdAt&sortDirection=DESC' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json'import requests
url = "https://apipub.firstbasehq.com/api/v1/shipment-notices"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://apipub.firstbasehq.com/api/v1/shipment-notices', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "SUBMITTED",
"sourceType": "SUPPLIER",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"warehouse": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"shipmentNoticeOrderItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendorSku": "<string>",
"vendorCode": "<string>",
"categoryCode": "<string>",
"productTitle": "<string>"
},
"status": "EXPECTED",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"quantity": 123,
"description": "<string>"
}
],
"shipmentNoticePackages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"shipmentNoticePackageItems": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"inventories": [
{
"id": "123E4567-E89B-12D3-A456-426614174000",
"deployStatus": "AWAITING_ARRIVAL",
"serialNumber": "SN123456789",
"warehouse": null
}
],
"status": "EXPECTED",
"expectedQuantity": 123,
"receivedQuantity": 123,
"skuId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vendorSku": "<string>"
}
],
"status": "PENDING",
"trackingCode": "<string>",
"shippingCarrier": "<string>",
"trackingUrl": "<string>"
}
],
"condition": "NEW",
"purchaseOrderNumber": "<string>",
"expectedShipDate": "2023-12-25",
"submittedBy": null
}
]{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}{
"errors": [
{
"detail": "Invalid request",
"source": "request"
}
]
}Authorizations
Query Parameters
Response
Paginated list of shipment notice orders