Skip to main content
GET
Get a replenishment

Authorizations

Authorization
string
header
required

Token returned by POST /auth/token, sent as Authorization: Bearer <token>.

Path Parameters

replenishment_id
integer
required

Cubbo id of the replenishment.

Response

The replenishment

Replenishment as returned by GET, including reception progress and supplier invoices.

id
integer

Replenishment id.

Example:

55001

status
enum<string>

Lifecycle status of a replenishment.

  • WITHOUT_SCHEDULING: created at a warehouse that books receiving appointments natively, but no appointment has been scheduled yet.
  • PENDING: registered but not yet requested to the warehouse (pre-arrival).
  • REQUESTED: announced to the warehouse and awaiting arrival; the initial status at warehouses without native appointment scheduling, and the status after an appointment is booked.
  • IN_TRANSIT: the shipment is on its way to the warehouse.
  • RECEIVED: the shipment was recorded at the dock; counting has not started.
  • PROCESSING: the warehouse is receiving and counting the units (stock has arrived).
  • IN_PUTAWAY: received units are being placed in storage locations.
  • COMPLETED: receiving and putaway finished; completed_at is set.
  • CANCELED: the replenishment was canceled; it no longer counts for external-reference uniqueness.
Available options:
WITHOUT_SCHEDULING,
PENDING,
REQUESTED,
IN_TRANSIT,
RECEIVED,
PROCESSING,
IN_PUTAWAY,
COMPLETED,
CANCELED
Example:

"REQUESTED"

store_id
integer

Store the replenishment belongs to.

Example:

1234

notes
string | null

Free-text notes for the warehouse.

Example:

"Pallet 2 contains fragile items"

created_at
string<date-time>

Creation time.

Example:

"2026-10-12T14:03:11.512Z"

expected_arrived_at
string<date-time> | null

Expected arrival date declared on creation.

Example:

"2026-11-02T15:00:00.000Z"

sell_ahead
boolean | null

Whether the announced units were made sellable before arrival.

Example:

false

declared_value
string | null

Declared total value of the shipment, as a decimal string; usually null.

Example:

null

is_return
boolean

true when this replenishment is the reception of a return.

Example:

false

completed_at
string<date-time> | null

When receiving finished; null until the status is COMPLETED.

Example:

null

supplier_invoices
object[]

Distinct supplier invoice numbers captured during receiving, sorted; empty when none were captured.

supplier_invoice_files
object[]

Documents uploaded during receiving (invoice PDF and supporting files) as short-lived links; empty when none.

return
object | null

The return being received, or null for a regular inbound replenishment.

replenishment_products
object[]

Announced lines with reception progress.