Moves product stock between locations within a store.

client.movement.createMovement(, ?, ?): MovementCreateMovementResponse { data, message, success }

POST/api/v2/public/stores/{store_number}/storeproductlocation/movement

ParametersExpand Collapse

storeNumber: string

params: MovementCreateMovementParams { AppUserName, body }

AppUserName?: string

Query param: The app user performing the movement.

body?: Array<Body>

Body param

allow_overage?: boolean | null

Whether to allow moving more than available stock.

from_location?: FromLocation { customer_order_line_number, customer_order_number, customer_order_shipment_line_number, 3 more }

The source location for the product movement.

customer_order_line_number?: number | null

The customer order line number at the source.

formatint32

customer_order_number?: string | null

The customer order number at the source.

customer_order_shipment_line_number?: number | null

The customer order shipment line number at the source.

formatint32

customer_order_shipment_number?: string | null

The customer order shipment number at the source.

location_code?: string | null

The source location code.

stock_pool?: number | null

The stock pool at the source location.

formatint32

product_number?: string | null

The product number to move.

quantity?: number

The quantity to move.

formatdouble

reason_code?: string | null

The reason code for the movement.

reference?: string | null

A reference identifier for the movement.

source?: string | null

The source system initiating the movement.

to_location?: ToLocation { customer_order_line_number, customer_order_number, customer_order_shipment_line_number, 3 more }

The destination location for the product movement.

customer_order_line_number?: number | null

The customer order line number at the destination.

formatint32

customer_order_number?: string | null

The customer order number at the destination.

customer_order_shipment_line_number?: number | null

The customer order shipment line number at the destination.

formatint32

customer_order_shipment_number?: string | null

The customer order shipment number at the destination.

location_code?: string | null

The destination location code.

stock_pool?: number | null

The stock pool at the destination location.

formatint32

ReturnsExpand Collapse

MovementCreateMovementResponse { data, message, success }

Standard success response returned by mutation endpoints.

data?: string | null

Optional data payload returned by the operation.

message?: string | null

Human-readable message describing the result.

success?: boolean

Indicates whether the operation completed successfully.

Moves product stock between locations within a store.

import Colleqtive from 'colleqtive-typescript';

const client = new Colleqtive({
  bearerToken: process.env['COLLEQTIVE_BEARER_TOKEN'], // This is the default and can be omitted
});

const response = await client.movement.createMovement('store_number');

console.log(response.data);

{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}

Returns Examples

{
  "data": "12345",
  "message": "Record created successfully.",
  "success": true
}