Receive Stock (Bulk)

Records a direct stock receive at a location, in one call, for existing variants and/or brand-new products (created on the fly). Returns the id and number of the created purchase receive. Requires the Receive Stock permission on the location. date (back-dating) is limited to 30 days and must be enabled for the company.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Bulk receive payload

integer

Receiving location id (required)

integer

Optional supplier id

string | null
string | null

Y-m-d

string | null
string | null

Back-date the receive, Y-m-d H:i:s in store timezone (max 30 days back; company setting required)

existing
array of objects

Lines for existing variants. MUST be present (send [] when only creating new products — omitting it errors). Items: {variant_id*, cost_price*, count*, sales_price, unit, unit_count, unit_scale, serials[], batches[], taxes[{id}]}

existing
new
array of objects

Products to create and receive in one step. Items: {name*, cost_price*, sales_price*, count*, cost_taxes[{id}]*, sales_taxes[{id}]*, extra{category, brand, supplier, unit, barcode, locations[]}}. cost_taxes and sales_taxes must be present (send [] for none — omitting them errors).

new
Headers
string
required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json