Start a bulk transfer

Move quantity of many products from one office to several offices in one request, the same way as the Products Bulk Transfer upload. The request is checked and saved, then the transfers run in the background: follow the result with GET /inventory/bulk-transfers/{id}. A transfer is one item of one destination; a request takes up to 10000 transfers. Items with the same product_id and package_id in different destinations are one row of the bulk transfer report. Send an Idempotency-Key to retry safely: the same key with the same request answers 202 with the bulk transfer already created, the same key with a different request answers 409. Ids and quantity are integers; a string of digits only, such as "12", is accepted too.

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

Office to take the quantity from.

destinations
array of objects
required
length ≥ 1

Destination offices, in order. Each office once, not the source office.

destinations*
integer
required

Office to move the quantity to.

integer | null

Bag, like Bag Name in the upload. Ignored for an office that is not On-Demand, like Bag Name.

items
array of objects
required
length ≥ 1

What to move to this office. Each product_id and package_id pair once.

items*
integer
required

Product.

integer | null

Package, like Package UID in the upload. Used only for a product tracked by packages (Metrc or package control); without it such a product is taken first in, first out. Ignored for any other product, like Package UID.

integer
required
≥ 1

Whole quantity.

Headers
string
length between 1 and 255

Optional key of 1 to 255 printable UTF-8 characters, unique within the company and kept for good. A repeated request with the same key and the same body returns the bulk transfer already created, and starts it again if it is still pending; with a different body the answer is 409.

Responses

400

Request body is not a JSON object

401

Unauthorized: rejected by the API gateway

403

Forbidden: the secret or the vendor API key is not valid, or the company has no admin user to act as

409

The Idempotency-Key was already used with a different request, or a request with the same key is being processed

422

Validation failed. The checks run in this order, and only the first failing one is answered: the Idempotency-Key; the fields of the body and more than 10000 transfers, all errors together; the source office not found or not ready; destination offices and bags not found, all of them together

503

The bulk transfer could not be started. With an Idempotency-Key, send the same request again

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