Orders

Update an order

This operation allows for updating properties of an order including options and metadata. It is not for editing the line items of an order.

put/v1/orders/{id}

Path parameters

idstring required

Request body

optionsobject nullable

<details> <summary>The options available for the order shipments.</summary>

    {
        "currency": "USD",
        "paid_by": "third_party",
        "payment_account_number": "123456789",
        "duty_paid_by": "recipient",
        "duty_account_number": "123456789",
        "invoice_number": "123456789",
        "invoice_date": "2020-01-01",
        "single_item_per_parcel": true,
        "carrier_ids": ["canadapost-test"],
    }
    </details>

metadataobject

User metadata for the shipment

Response

idstring

A unique identifier

object_typestring

Specifies the object type

order_idstring required

The source' order id.

order_datestring nullable

The order date. format: YYYY-MM-DD

sourcestring

The order's source.

status'unfulfilled' | 'cancelled' | 'fulfilled' | 'delivered' | 'partial'

The order status.

optionsobject nullable

<details> <summary>The options available for the order shipments.</summary>

    {
        "currency": "USD",
        "paid_by": "third_party",
        "payment_account_number": "123456789",
        "duty_paid_by": "third_party",
        "duty_account_number": "123456789",
        "invoice_number": "123456789",
        "invoice_date": "2020-01-01",
        "single_item_per_parcel": true,
        "carrier_ids": ["canadapost-test"],
        "preferred_service": "fedex_express_saver",
    }
    </details>

metaobject nullable

system related metadata.

metadataobject

User metadata for the order.

test_modeboolean required

Specify whether the order is in test mode or not.

created_atstring required

The shipment creation datetime.<br/> Date Format: YYYY-MM-DD HH:MM:SS.mmmmmmz

Changes

No recorded changes to this endpoint across all 1 revision of this API.