Update a business order

patch

https://api.scalev.com/v3/orders/{id}

Requires the order:update scope. Update order details by ID.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Canonical UUIDv7 order primary key. For migrated orders, legacy numeric core_order.id values remain accepted for compatibility.

Body Params

Order update data

address

string

Recipient address

channel_unique_id

string

Channel unique ID

courier_service_id

integer

Courier service ID

customer_email

string

Customer email

customer_name

string

Customer name

customer_phone

string

Customer phone number

dropshipper_name

string

Dropshipper name

dropshipper_phone

string

Dropshipper phone

financial_entity_id

integer

Financial entity ID

is_dropshipping

boolean

Is dropshipping order

location_id

integer

Location ID

notes

string

Order notes

orderbundles

array of objects

Order bundles

orderbundles

ordervariants

array of objects

Order variants

ordervariants

other_income

number

Other income amount

other_income_name

string

Other income name

page_unique_id

string

Page unique ID

payment_account_holder

string

Payment account holder name

payment_account_number

string

Payment account number

payment_account_unique_id

string

Payment account unique ID

payment_method

string

enum

Order payment method

postal_code

string

Postal code

product_discount

number

Product discount amount

shipment_provider_code

string | null

enum

Shipment provider code

Allowed:

shipping_cost

number

Shipping cost

shipping_discount

number

Shipping discount amount

transferproof_url

string

Transfer proof URL

warehouse_unique_id

string

Warehouse unique ID

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Order updated successfully

400Bad Request

401Unauthorized

403Forbidden

404Not Found