Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Body

application/json

Request to create a shipment notice — an advance notification that equipment is on its way to a Firstbase warehouse

warehouse_id
string<uuid>
required

ID of the destination Firstbase warehouse where the equipment will be delivered

Example:

"ed92d1a0-a8ee-4768-bbcb-26dd4bfdf8a4"

source_type
enum<string>
required

Origin of the shipment: SUPPLIER (from a vendor/manufacturer) or OFFICE (from one of the organization's offices)

Available options:
SUPPLIER,
OFFICE
Example:

"SUPPLIER"

condition
enum<string>
required

Physical condition of the items being shipped (NEW or USED)

Available options:
NEW,
USED
Example:

"NEW"

shipments
object[]
required

List of individual shipment packages, each with tracking info and item details

Minimum array length: 1
purchase_order_number
string

Purchase order number from the organization's procurement system. Required when source_type is SUPPLIER.

Response

Shipment notice created

Shipment notice response

id
string<uuid>
required

Shipment notice order ID

shipments
object[]
required

Shipments (packages)

source_type
enum<string>

Source type

Available options:
SUPPLIER,
OFFICE
status
enum<string>

Status

Available options:
SUBMITTED,
PROCESSING,
COMPLETED,
PARTIALLY_COMPLETED,
NOT_COMPLETED,
CANCELLED
condition
enum<string>

Condition

Available options:
NEW,
USED
warehouse_id
string<uuid>

Warehouse ID

purchase_order_number
string

Purchase order number

created_at
string<date-time>

Creation timestamp