Update Order

patch

https://api.warehance.com/v1/orders/{id}

Required permission: write_orders

Update details of an existing order for your organization or client.

Path Params

integer

required

≥ 1

The ID of the order to update.

Body Params

shipping_method_id

integer | null

≥ 1

The ID of the new shipping method for the order.

warehouse_id

integer | null

≥ 1

The ID of the new warehouse fulfilling this order.

hold_until_date

date-time | null

The new date and time until which to hold the order.

required_ship_date

date-time | null

The new date by which the order must be shipped.

order_date

date-time | null

The new date and time of the order. If provided, it must be in the past.

ignore_address_validation

boolean | null

Whether to ignore address validation errors.

exclude_from_batch_shipping

boolean | null

Whether to exclude the order from batch shipping.

exclude_from_picking

boolean | null

Whether to exclude the order from picking.

exclude_from_single_item_batch

boolean | null

Whether to exclude the order from single item batch.

address_hold

boolean | null

Set address hold to true or false.

payment_hold

boolean | null

Set payment hold to true or false.

warehouse_hold

boolean | null

Set warehouse hold to true or false.

allocation_hold

boolean | null

Set allocation hold to true or false.

fraud_hold

boolean | null

Set fraud hold to true or false.

packing_note

string

A note about the packing of the order.

gift_note

string

A note about the gift of the order.

internal_note

string

A note about the order for internal use.

customs_contents_type

string | null

enum

The type of contents for customs purposes.

customs_contents_explanation

string | null

An explanation of the contents for customs purposes.

custom_field1

string | null