Skip to main content
GET
Preview a receipt by product

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_ Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Path Parameters

id
string<uuid>
required

Query Parameters

by_product
string

The rows: a JSON array of { product_id, variant_id, quantity, split, split_reason, allocation_note_id, serial_numbers }, as the receive's by_product takes them. When it is sent, the single-row parameters below are not read. Text that is not a JSON array is refused 422 invalid_parameter.

product_id
string<uuid>

One row's product, when by_product is not sent. With neither, the preview is refused 400 missing_field.

variant_id
string<uuid>

The row's variant, for a product sold by variant.

quantity
integer

The row's units, a whole number, 0 or more (anything else is the row's blocker quantity_invalid).

Required range: x >= 0
split
string

The row's own placement of its units on the product's lines, instead of the rank: a JSON array of { return_item_id, quantity } that sums to quantity. Text that is not JSON is refused 422 invalid_parameter.

split_reason
string

Why a split differs from the rank, in 10 characters or more (else the row's blocker split_reason_required).

allocation_note_id
string<uuid>

A note of this entity that already says why the split differs from the rank, instead of split_reason.

serial_numbers
string

The row's serial numbers, separated by commas, one per unit; each places its unit on the line that sold it.

Response

Where each row's units would go, and what the receipt would refuse. Nothing is written.

The preview of a receipt by product: each row's place on the return's lines, or what refuses it.

data
object
required