cURL
curl -sS -X POST 'https://apipub.firstbasehq.com/api/v1/shipment-notices' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"warehouse_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"source_type": "SUPPLIER",
"condition": "NEW",
"shipments": [
{
"shipping_carrier": "UPS",
"tracking_code": "1Z999AA10123456784",
"items": [
{
"sku_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"quantity": 1
}
]
}
]
}'import requests
url = "https://apipub.firstbasehq.com/api/v1/shipment-notices"
payload = {
"warehouse_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"source_type": "SUPPLIER",
"condition": "NEW",
"shipments": [
{
"shipping_carrier": "UPS",
"tracking_code": "1Z999AA10123456784",
"items": [
{
"sku_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"quantity": 1
}
]
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
warehouse_id: 'ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4',
source_type: 'SUPPLIER',
condition: 'NEW',
shipments: [
{
shipping_carrier: 'UPS',
tracking_code: '1Z999AA10123456784',
items: [{sku_id: 'ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4', quantity: 1}]
}
]
})
};
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",
"shipments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expected_quantity": 123,
"description": "<string>"
}
],
"shipping_carrier": "<string>",
"tracking_code": "<string>",
"tracking_url": "<string>"
}
],
"source_type": "SUPPLIER",
"status": "SUBMITTED",
"condition": "NEW",
"warehouse_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchase_order_number": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"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
Create shipment notice
Creates a new shipment notice order. Identify the source as SUPPLIER (with purchase_order_number) or OFFICE. Each shipment contains items identified by sku_id with a quantity.
POST
https://apipub.firstbasehq.com
/
api
/
v1
/
shipment-notices
cURL
curl -sS -X POST 'https://apipub.firstbasehq.com/api/v1/shipment-notices' \
-H 'Authorization: ApiKey YOUR_API_KEY' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"warehouse_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"source_type": "SUPPLIER",
"condition": "NEW",
"shipments": [
{
"shipping_carrier": "UPS",
"tracking_code": "1Z999AA10123456784",
"items": [
{
"sku_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"quantity": 1
}
]
}
]
}'import requests
url = "https://apipub.firstbasehq.com/api/v1/shipment-notices"
payload = {
"warehouse_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"source_type": "SUPPLIER",
"condition": "NEW",
"shipments": [
{
"shipping_carrier": "UPS",
"tracking_code": "1Z999AA10123456784",
"items": [
{
"sku_id": "ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4",
"quantity": 1
}
]
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
warehouse_id: 'ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4',
source_type: 'SUPPLIER',
condition: 'NEW',
shipments: [
{
shipping_carrier: 'UPS',
tracking_code: '1Z999AA10123456784',
items: [{sku_id: 'ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4', quantity: 1}]
}
]
})
};
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",
"shipments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sku_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"expected_quantity": 123,
"description": "<string>"
}
],
"shipping_carrier": "<string>",
"tracking_code": "<string>",
"tracking_url": "<string>"
}
],
"source_type": "SUPPLIER",
"status": "SUBMITTED",
"condition": "NEW",
"warehouse_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purchase_order_number": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"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
Body
application/json
Request to create a shipment notice — an advance notification that equipment is on its way to a Firstbase warehouse
Response
Shipment notice created
Shipment notice response