Skip to main content

Preview Vendor Credit Write-Off Impact

GET 
/api/vendor-credits/:vendor_credit/write-off-impact

Get a read-only preview of the order allocations that authorizing this vendor credit would consume when its write-off lines post their outbound decrement. Each row is one product whose stock the write-off would remove, split into free, soft-reserved and hard-allocated quantities, and lists the affected sales-order allocations highest-priority first so you can see which orders — and which printed shipping labels — would be demoted or voided before you authorize the credit.

This endpoint makes no changes.

Response fields:

  • data[].product_id / product_sku / product_name — the product the action would consume stock for.
  • data[].shortfall_quantity — how much more than the available quantity the action removes; stock goes negative when greater than 0.
  • data[].unallocated_quantity / soft_allocated_quantity / hard_allocated_quantity — the free / soft-reserved / hard-allocated (label-printed) split of the consumed quantity.
  • data[].affected_allocations[] — the order allocations that would be consumed, highest priority first. allocation_type is soft or hard. For hard rows, fulfillment_id and carrier identify the printed label and carrier_void_supported / voidable_status (voidable or otherwise) indicate whether the label can be voided through the API.

Authentication: Requires Bearer token (PAT).

Request​

Responses​

OK

Response Headers
    Content-Type