---
title: "Updates the status of a chosen order"
method: PUT
path: "/api/v1/orders/{id}/status"
tags: ["Orders"]
---

# Updates the status of a chosen order

`PUT /api/v1/orders/{id}/status`

## Path parameters

- `id` integer, required — The Order Id

## Request body

- V1OrderStatus
  - `status` string, required
  - `email_customer` boolean

## Response `200`

The affected order

- TempestResponseV1Order
  - `meta` object, nullable
  - `links` TempestLink[], nullable
    - `rel` string, nullable
    - `href` string, nullable
  - `validation_result` TempestValidationError[], nullable
    - `member_names` string[], nullable
    - `error_message` string, nullable
  - `errors` object, nullable
  - `data` V1Order
    - `id` integer, required
    - `order_number` string, required
    - `order_date` string, date-time, required
    - `is_confirmed` boolean
    - `sub_total` number, double
    - `total_delivery` number, double
    - `total_tax` number, double
    - `total_cost` number, double
    - `status` string, nullable
    - `payment_status` string, nullable
    - `delivery_method_id` integer
    - `delivery_method` string, nullable
    - `transaction_id` string, nullable
    - `hash_code` string, nullable
    - `transaction_status` string, nullable
    - `order_type` string, required
    - `use_shipping_address` boolean
    - `shipping_address` V1ShippingAddress
      - `first_name` string, required
      - `last_name` string, required
      - `id` integer
      - `created_date` string, date-time, nullable
      - `modified_date` string, date-time, nullable
      - `customer_id` integer
      - `is_preferred_billing_address` boolean
      - `is_preferred_shipping_address` boolean
      - `company` string, nullable
      - `address` string, required
      - `address2` string, nullable
      - `town` string, required
      - `county` string, nullable
      - `country` string, required
      - `friendly_country` string, nullable
      - `post_code` string, required
      - `telephone` string, nullable
      - `fax` string, nullable
    - `internal_notes` string, nullable
    - `customer_facing_notes` string, nullable
    - `emailed` boolean
    - `discounts` string, nullable
    - `discounts_total` number, double
    - `shipping_company` string, nullable
    - `ip_address` string, nullable
    - `guid` string, uuid, required
    - `last_updated` string, date-time, nullable
    - `delivery_tax_rate` number, double, nullable
    - `delivery_includes_tax` integer, nullable
    - `custom_fields_total` number, double, nullable
    - `custom_fields_tax_total` number, double, nullable
    - `items` V1OrderItem[], nullable
      - `id` integer, required
      - `item_delivery` number, double, required
      - `item_discount` number, double, required
      - `item_name` string, required
      - `item_options` string, required
      - `item_order_note` string, required
      - `item_price` number, double, required
      - `item_tax` number, double, required
      - `item_tax_id` integer, required
      - `item_tax_rate` number, double, required
      - `order_number` string, required
      - `quantity` integer, required
      - `original_item_id` integer, required
      - `order_id` integer, required
      - `product` V1Product
        - `id` integer
        - `category_id` integer, nullable
        - `name` string, required
        - `description` string, nullable
        - `short_description` string, nullable
        - `number_in_stock` integer
        - `price` number, double
        - `rrp` number, double
        - `product_code` string, nullable
        - `charge_delivery` boolean
        - `special_offer` boolean
        - `brand` string, nullable
        - `condition` string, nullable
        - `gtin` string, nullable
        - `mpn` string, nullable
        - `product_weight` number, double
        - `can_be_added_to_cart` boolean
        - `tax_applicable` boolean
        - `tax_rate_id` integer, nullable
        - `live` boolean
        - `order_note` string, nullable
        - `redirect_url` string, nullable
        - `last_modified` string, date-time
        - `meta_description` string, nullable
        - `meta_keywords` string, nullable
        - `meta_title` string, nullable
        - `total_product_stock` integer
        - `parent_product_id` integer, nullable
        - `options` V1ProductOption[], nullable
          - `id` integer
          - `product_id` integer
          - `name` string, required
          - `is_required` boolean
          - `type` string, required
          - `size` integer, required
          - `option_items` V1ProductOptionItem[], nullable
            - `id` integer
            - `product_option_id` integer
            - `name` string, required
            - `price` number, double
            - `is_placeholder` boolean
        - `variants` V1ProductVariant[], nullable
          - `id` integer
          - `parent_product_id` integer
          - `product_code` string, nullable
          - `rrp` number, double
          - `is_default_variant` boolean
          - `number_in_stock` integer
          - `price` number, double
          - `product_weight` number, double
          - `condition` string, nullable
          - `gtin` string, nullable
          - `mpn` string, nullable
          - `live` boolean
          - `combination_name` string, nullable
          - `variant_combinations` V1VariantCombination[], nullable
            - `variant_name` string, required
            - `variant_choice` string, required
        - `categories` V1ProductCategory[], nullable
          - `category_id` integer
          - `is_category_managed` boolean
        - `attribute_items` V1ProductAttributeItem[], nullable
          - `id` integer
          - `attribute_key` string, nullable
          - `product_id` integer
          - `attribute_value` string, nullable
          - `visible` boolean
          - `ebay_attribute_name` string, nullable
          - `order_location` integer
        - `media_links` V2ProductMedia[], nullable
          - `id` integer
          - `product_id` integer
          - `parent_product_id` integer
          - `position` integer
          - `image_id` integer
          - `video_id` integer, nullable
          - `image` V2ProductMediaImage
            - `id` integer
            - `local` string, nullable
            - `remote` string, nullable
            - `width` integer, nullable
            - `height` integer, nullable
            - `location` string, nullable
            - `upload_date` string, date-time
            - `section_type` string, nullable
            - `cdn` string, nullable
          - `video` V2ProductMediaVideo
            - `id` integer
            - `original_url` string, nullable
            - `width` integer
            - `height` integer
        - `order_location` integer
        - `seo_friendly_url` string, nullable
    - `customer_details` V1OrderCustomerDetails
      - `customer_id` integer
      - `email_address` string, nullable
      - `first_name` string, nullable
      - `last_name` string, nullable
      - `company` string, nullable
      - `address` string, nullable
      - `address2` string, nullable
      - `town` string, nullable
      - `county` string, nullable
      - `country` string, nullable
      - `friendly_country` string, nullable
      - `post_code` string, nullable
      - `telephone` string, nullable
      - `fax` string, nullable
      - `billing_address_verified` boolean
    - `gift_card_activities` V1OrderGiftCardActivity[], nullable
      - `id` integer
      - `gift_card_id` integer
      - `customer_id` integer
      - `order_id` integer
      - `date` string, date-time
      - `amount` number, double
      - `status` string, nullable
    - `custom_fields` string, nullable
    - `delivery_tracking_number` string, nullable
    - `delivery_tracking_company` string, nullable
    - `delivery_tracking_url` string, nullable
    - `delivery_slot_date` string, date-time, nullable
    - `delivery_slot_is_all_day` boolean, nullable
    - `delivery_slot_start_time` string, nullable
    - `delivery_slot_end_time` string, nullable

## Other responses

- `400` — Invalid Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.dev/ekm/apis/ekm-partner-api.md) · [All operations](https://skmtc.dev/ekm/apis/ekm-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ekm/ekm-partner-api/revisions/853bef073bb3/schema)
