Update Customer Order

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

Updates an existing customer order and its lines in one store. Use it to change quantities or status after the order was created, rather than deleting and recreating it.

Path ParametersExpand Collapse

store_number: string

Body ParametersJSONExpand Collapse

orders: optional object { order_number, is_active, is_claimed, 5 more }

order_number: string

minLength1

is_active: optional boolean

is_claimed: optional boolean

is_picked: optional boolean

is_rejected: optional boolean

order_lines: optional array of object { line_number, product_number, barcode, 11 more }

line_number: number

formatint64

product_number: string

minLength1

barcode: optional string

delivery_date: optional string

formatdate-time

description: optional string

is_picked: optional boolean

is_picked_from_warehouse: optional boolean

ordering_datetime: optional string

formatdate-time

picked_quantity: optional number

formatdouble

pickup_date: optional string

formatdate-time

preferred_location_code: optional string

price: optional number

formatdouble

quantity: optional number

formatdouble

stock_pool: optional number

formatint32

rejection_reason_code: optional string

rejection_reason_code_description: optional string

ReturnsExpand Collapse

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.

Update Customer Order

curl https://api.colleqtive.net/api/v2/public/stores/$STORE_NUMBER/orders/customerorder \
    -X PUT \
    -H "Authorization: $COLLEQTIVE_BEARER_TOKEN"

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}

Returns Examples

{
  "success": true,
  "data": "data",
  "message": "message"
}

{
  "code": 401,
  "status": "error",
  "message": "Authentication failed.",
  "error": "unauthorized",
  "error_description": "Authentication failed."
}

{
  "code": 500,
  "status": "fail",
  "message": "The request could not be processed.",
  "error": "internal_error",
  "error_description": "The request could not be processed."
}