API Reference

Movement

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Moves product stock between locations within a store.

movement.create_movement(strstore_number, MovementCreateMovementParams**kwargs) -> MovementCreateMovementResponse

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

Moves product stock between locations within a store.

ParametersExpand Collapse

store_number: str

app_user_name: Optional[str]

The app user performing the movement.

body: Optional[Iterable[Body]]

allow_overage: Optional[bool]

Whether to allow moving more than available stock.

from_location: Optional[BodyFromLocation]

The source location for the product movement.

customer_order_line_number: Optional[int]

The customer order line number at the source.

formatint32

customer_order_number: Optional[str]

The customer order number at the source.

customer_order_shipment_line_number: Optional[int]

The customer order shipment line number at the source.

formatint32

customer_order_shipment_number: Optional[str]

The customer order shipment number at the source.

location_code: Optional[str]

The source location code.

stock_pool: Optional[int]

The stock pool at the source location.

formatint32

product_number: Optional[str]

The product number to move.

quantity: Optional[float]

The quantity to move.

formatdouble

reason_code: Optional[str]

The reason code for the movement.

reference: Optional[str]

A reference identifier for the movement.

source: Optional[str]

The source system initiating the movement.

to_location: Optional[BodyToLocation]

The destination location for the product movement.

customer_order_line_number: Optional[int]

The customer order line number at the destination.

formatint32

customer_order_number: Optional[str]

The customer order number at the destination.

customer_order_shipment_line_number: Optional[int]

The customer order shipment line number at the destination.

formatint32

customer_order_shipment_number: Optional[str]

The customer order shipment number at the destination.

location_code: Optional[str]

The destination location code.

stock_pool: Optional[int]

The stock pool at the destination location.

formatint32

ReturnsExpand Collapse

class MovementCreateMovementResponse: …

Standard success response returned by mutation endpoints.

data: Optional[str]

Optional data payload returned by the operation.

message: Optional[str]

Human-readable message describing the result.

success: Optional[bool]

Indicates whether the operation completed successfully.

Moves product stock between locations within a store.

Python

HTTP

TypeScript

Python

C#

import os
from colleqtive_sdk import Colleqtive

client = Colleqtive(
    bearer_token=os.environ.get("COLLEQTIVE_BEARER_TOKEN"),  # This is the default and can be omitted
)
response = client.movement.create_movement(
    store_number="store_number",
)
print(response.data)

200 example

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

Returns Examples

200 example

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