Update Order Item

Replaces a single line item and recalculates the order totals.

As with other update operations, the complete item must be passed. Any fields left out will be updated as blank.

put

Authorizations

ORDERDESK-API-KEYstringRequired

Your API key, found under Store Settings on the API tab. This should be kept server-side.

ORDERDESK-STORE-IDstringRequired

Your store ID, found under Store Settings on the API tab.

Path parameters

order_idintegerRequired

Order Desk's internal order ID. This is not your source_id.

Example: 736745

item_idintegerRequired

Order Desk's internal ID for the order item.

Example: 1670028

Body

idintegerOptional

If an id field is passed the item will be updated. Otherwise it will be added.

Example: 1670028

namestringOptionalExample: ODU Campus Hoodie

pricenumber · doubleOptionalDefault: 0Example: 19

quantityintegerOptionalDefault: 1Example: 2

weightnumber · doubleOptionalExample: 1.2

codestringOptional

Item SKU or product code.

Example: ODU-HOOD-NVY-L

delivery_typestring · enumOptional

Available options are ship, noship, download, or future. Defaults to ship.

Default: shipPossible values:

category_codestringOptional

Further details about the type of item. Freeform text.

Example: Apparel

fulfillment_methodstringOptional

Fulfillment method responsible for this item, when one applies.

Other propertiesanyOptional

Other propertiesanyOptional

Responses

200

The item was updated.

application/json

statusstring · enumRequired

Either success or error.

Possible values:

messagestringOptional

Describes the result. Always present when an error occurs.

execution_timestringOptional

Time taken to process the request.

Example: 0.1524 seconds

400

The request was rejected. message names the problem.

application/json

401

Authentication failed. See the Authentication guide, and note that an invalid store ID blocks your store rather than simply failing the request.

application/json

404

No record matches that ID in your store.

application/json

413

An item's metadata or variation_list is over the limit. See the Errors guide for the sizes.

application/json

429

You are sending too fast. Wait X-Retry-After seconds. See the Rate Limits guide.

application/json

default

The request could not be completed.

application/json

put/orders/{order_id}/order-items/{item_id}

curl "https://app.orderdesk.me/api/v2/orders/736745/order-items/1670028" \
  -X PUT \
  -H "ORDERDESK-STORE-ID: your-store-id" \
  -H "ORDERDESK-API-KEY: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"name": "ODU Campus Hoodie", "code": "ODU-HOOD-NVY-L", "price": 19, "quantity": 3, "weight": 1.2, "delivery_type": "ship", "variation_list": {"Size": "Large", "Color": "Red"}}'

{
  "status": "success",
  "message": "Order Item Updated",
  "execution_time": "0.1524 seconds"
}