Customer Orders

List Customer Orders

GET/api/v2/public/stores/{store_number}/orders/customerorders

Create Customer Orders

POST/api/v2/public/stores/{store_number}/orders/customerorders

Create Multi Store Customer Orders

POST/api/v2/public/orders/customerorders

Update Customer Order

PUT/api/v2/public/stores/{store_number}/orders/customerorder

Create Customer Order Clearance

POST/api/v2/public/customerorders/clearance

ModelsExpand Collapse

CustomerOrderListCustomerOrdersResponse object { is_active, is_claimed, is_picked, 19 more }

Properties

is_active: boolean

is_claimed: boolean

is_picked: boolean

is_rejected: boolean

status_id: number

formatint32

total_lines: number

formatint32

total_quantity: number

formatdouble

comment: optional string

customer_name: optional string

description: optional string

lines: optional array of object { id, explicit_order, is_picked, 21 more }

id: number

formatint64

explicit_order: boolean

is_picked: boolean

is_template: boolean

line_number: number

formatint64

picked_quantity: number

formatdouble

price: number

formatdouble

quantity: number

formatdouble

stock_pool: number

formatint32

store_walking_order: number

formatint64

barcode: optional string

delivery_date: optional string

formatdate-time

delivery_qty: optional number

formatdouble

description: optional string

moved_quantity: optional number

formatdouble

next_ordering_datetime: optional string

formatdate-time

picked_username: optional string

picking_stock_pool_array: optional array of string

pickup_date: optional string

formatdate-time

preferred_location_code: optional string

product_number: optional string

reference: optional string

stock_location: optional string

store_locations: optional array of object { location_order, quantity, customer_order_line_number, 16 more }

location_order: number

formatint32

quantity: number

formatdouble

customer_order_line_number: optional number

formatint32

customer_order_number: optional string

customer_order_shipment_line_number: optional number

formatint32

customer_order_shipment_number: optional string

default_stock_pool: optional string

location_code: optional string

most_likely_pool_1: optional number

formatdouble

most_likely_pool_10: optional number

formatdouble

most_likely_pool_2: optional number

formatdouble

most_likely_pool_3: optional number

formatdouble

most_likely_pool_4: optional number

formatdouble

most_likely_pool_5: optional number

formatdouble

most_likely_pool_6: optional number

formatdouble

most_likely_pool_7: optional number

formatdouble

most_likely_pool_8: optional number

formatdouble

most_likely_pool_9: optional number

formatdouble

tags: optional array of string

order_number: optional string

order_type_code: optional string

order_type_description: optional string

pickup_date: optional string

reference: optional string

rejection_reason_code: optional string

rejection_reason_code_description: optional string

sales_order_id: optional string

store_number: optional string

stores_allowed: optional string

total_delivery_quantity: optional number

formatdouble

CustomerOrderCreateCustomerOrdersResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.

CustomerOrderCreateMultiStoreCustomerOrdersResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.

CustomerOrderUpdateCustomerOrderResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.

CustomerOrderCreateCustomerOrderClearanceResponse object { success, data, message }

Standard success response returned by mutation endpoints.

success: boolean

Indicates whether the operation completed successfully.

data: optional string

Optional data payload returned by the operation.

message: optional string

Human-readable message describing the result.