---
title: "Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the order object will be updated, and those fields not provided will be left alone. Updating an order with a specified ID that does not exist will result in an error response</strong>"
method: PATCH
path: "/orders/{id}"
tags: ["orders"]
---

# Update an order associated with a given ID in the eCommerce system. The update API uses the PATCH HTTP verb, so only those fields provided in the order object will be updated, and those fields not provided will be left alone. Updating an order with a specified ID that does not exist will result in an error response</strong>

`PATCH /orders/{id}`

## Path parameters

- `id` string, required

## Query parameters

- `action` string

## Headers

- `Authorization` string, required

## Request body

- OrderPatch
  - `billingPerson` Person
    - `city` string
    - `companyName` string
    - `countryCode` string
    - `countryName` string
    - `name` string
    - `phone` string
    - `postalCode` string
    - `stateName` string
    - `stateOrProvinceCode` string
    - `stateOrProvinceName` string
    - `street` string
  - `couponDiscount` number, double
  - `customerId` number, double
  - `customerTaxExempt` boolean
  - `customerTaxId` integer
  - `customerTaxIdValid` boolean
  - `discount` number, double
  - `email` string
  - `fulfillmentStatus` string — AWAITING_PROCESSING, PROCESSING, SHIPPED, DELIVERED, WILL_NOT_DELIVER, RETURNED, READY_FOR_PICKUP
  - `globalReferer` string
  - `hidden` boolean
  - `items` Item[]
    - `categoryId` integer
    - `couponApplied` boolean — true/false. shows whether a discount coupon is applied for this item
    - `digital` boolean — true/false. shows whether the item has downloadable files attached
    - `fixedShippingRate` number, double
    - `fixedShippingRateOnly` boolean — true/false. shows whether the fixed shipping rate is set for the product
    - `hdThumbnailUrl` string
    - `id` integer
    - `imageUrl` string
    - `isShippingRequired` boolean — true/false. shows whether the item requires shipping
    - `name` string
    - `price` number, double
    - `productAvailable` boolean — true/false. shows whether product is available or not
    - `productId` integer
    - `productPrice` number, double
    - `quantity` integer
    - `quantityInStock` number, double
    - `shipping` number, double
    - `sku` string
    - `smallThumbnailUrl` string
    - `tax` number, double
    - `taxes` Tax[]
      - `name` string
      - `total` number, double
      - `value` number, double
    - `trackQuantity` boolean — true/false. shows whether the store admin set to track the quantity of this product and get low stock notifications
    - `weight` number, double
  - `membershipBasedDiscount` number, double
  - `orderComments` string
  - `paymentModule` string
  - `paymentStatus` string — AWAITING_PAYMENT, PAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, INCOMPLETE
  - `privateAdminNotes` string
  - `refererUrl` string
  - `reversedTaxApplied` boolean
  - `sample` boolean
  - `shippingMethod` string
  - `shippingOption` ShippingOption
    - `estimatedTransitTime` string
    - `isPickup` boolean
    - `shippingCarrierName` string
    - `shippingMethodName` string
    - `shippingRate` number, double
  - `shippingPerson` Person
    - `city` string
    - `companyName` string
    - `countryCode` string
    - `countryName` string
    - `name` string
    - `phone` string
    - `postalCode` string
    - `stateName` string
    - `stateOrProvinceCode` string
    - `stateOrProvinceName` string
    - `street` string
  - `subtotal` number, double
  - `tax` number, double
  - `taxesOnShipping` Tax[]
    - `name` string
    - `total` number, double
    - `value` number, double
  - `total` number, double
  - `totalAndMembershipBasedDiscount` number, double
  - `volumeDiscount` number, double

## Response `200`

OK - Everything worked as expected

## Other responses

- `400` — Bad Request - Often due to a missing request parameter
- `401` — Unauthorized - An invalid element token, user secret and/or org secret provided
- `403` — Forbidden - Access to the resource by the provider is forbidden
- `404` — Not found - The requested resource is not found
- `405` — Method not allowed - Incorrect HTTP verb used, e.g., GET used when POST expected
- `406` — Not acceptable - The response content type does not match the 'Accept' header value
- `409` — Conflict - If a resource being created already exists
- `415` — Unsupported media type - The server cannot handle the requested Content-Type
- `500` — Server error - Something went wrong on the Cloud Elements server
- `502` — Provider server error - Something went wrong on the Provider or Endpoint's server

---

[API](https://skmtc.net/cloud-elements/apis/ecwid.md) · [All operations](https://skmtc.net/cloud-elements/apis/ecwid/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloud-elements/ecwid/revisions/6c2a6ade2a5b/schema)