Skip to main content
POST
Create Stock Transfer

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

Idempotency-Key
string

Optional, client-generated key for deduplicating repeated write requests. A repeated request with the same key returns the originally recorded result instead of executing the effect again.

Required string length: 1 - 255
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Body

application/json

Request model for CreateStockTransfer command endpoint. Route parameters bind from the route, query parameters from the query string, everything else from the body.

sourceWarehouseId
string<uuid>
required

Standard warehouse the items are transferred from. It must be active.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

targetWarehouseId
string<uuid>
required

Standard warehouse the items are transferred to. It must be active and differ from the source warehouse.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

shippingMethodId
string<uuid>
required

Shipping method used to move the items. It must be an active shipping method of your own.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

lineItems
object[]
required

Items and quantities to transfer. At least one line item is required.

expectedDeliveryDate
string<date-time>

Date on which the items are expected to arrive in the target warehouse. Must be today or later.

note
string

Internal note on the stock transfer.

Response

The stock transfer was successfully created.

Creates a new stock transfer between two standard warehouses, together with its line items. The transit warehouse for the pair of warehouses is determined automatically. The new stock transfer is open and can be shipped right away. - Response

stockTransferId
string<uuid>
required

The ID of the newly created stock transfer.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"