Skip to main content

Preview Release Impact

POST 
/api/amazon/:integrationInstance/removal-shipments/:removalShipment/receive/preview-release-impact

Dry-run preview of which back-ordered sales orders would be filled by receiving this Amazon FBA removal shipment, per sellable line. Read-only — nothing is received, no stock moves and no allocation changes.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Post the receipt payload you would send to Receive Shipment. The sellable quantity_new units on each line are treated as a hypothetical receipt into the removal order's receiving warehouse.

Request body:

  • receipt_date (string, required, date) — the receipt date.
  • items (array, required, at least 1) — one entry per received product line.
  • items[].quantity_new (integer, required, >= 0) — resellable units received.
  • items[].quantity_discarded (integer, required, >= 0) — damaged units discarded.
  • items[].cogs_per_unit (number, required, >= 0) — landed cost per unit.
  • items[].product_id (integer, optional) — the product received. May be null ONLY for a discard-only receipt of an FNSKU marked as an unknown item, in which case quantity_new and quantity_blemished must be 0 and quantity_discarded > 0. Otherwise it is required.
  • items[].removal_shipment_id (integer, optional) — the removal shipment the line came from.
  • items[].quantity_blemished (integer, optional, >= 0) — units received as blemished.
  • items[].blemished_configurations (array, optional) — one entry per blemished unit.
  • items[].discard_notes (string, optional, max 1000) — reason for the discard, kept on the audit trail.
  • release_backorders (boolean, optional) — true force-releases waiting back-orders past the tenant auto-release setting, false receives as free stock, and omitting it honours the tenant setting.
  • release_sales_order_ids (array of integers, optional) — restrict the release to specific sales orders. Omitted or empty releases to all waiting back-orders.

Response: data is an array with one row per received product:

  • product_id, product_sku, product_name — the product being received.
  • releasable_quantity — total units that would be released to back-orders.
  • orders — sales orders that would receive stock, each with sales_order_id, order_number, customer_name and quantity.
  • held_back — demand that would NOT be released, each with a reason_kept explaining why (for example "Insufficient supply").

Authentication: requires a Bearer token.

Request​

Responses​

OK

Response Headers
    Content-Type