> ## Documentation Index
> Fetch the complete documentation index at: https://enterprise-docs.bglobale.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Order Status

> The UpdateOrderStatus API lets you cancel an order with a reason (and notify the customer accordingly) or move an order to a processing status (used by Global‑e or specific cases not covered in this guide). This guide focuses on cancelling orders prior to dispatch.

<Note>
  Part of the [Order Status Updates (from Merchant)](/order-status-updates--m-to-ge-) integration guide — see it for when and how to use this endpoint.
</Note>


## OpenAPI

````yaml api-reference/specs/updateorderstatus.yaml POST /Order/UpdateOrderStatus
openapi: 3.0.3
info:
  title: UpdateOrderStatus
  version: 1.0.0
  description: >-
    The UpdateOrderStatus API lets you cancel an order with a reason (and notify
    the customer accordingly) or move an order to a processing status. This
    guide focuses on cancelling orders prior to dispatch.
servers:
  - url: https://{globale_api_domain}
    variables:
      globale_api_domain:
        default: globale_api_domain
        description: Global-e API host, supplied to the merchant by Global-e.
security: []
tags:
  - name: UpdateOrderStatus
    x-page-title: Update Order Status
  - name: 'Direction: Merchant → Global-e'
  - name: 'Domain: Orders'
paths:
  /Order/UpdateOrderStatus:
    post:
      tags:
        - UpdateOrderStatus
      summary: Update Order Status
      description: >-
        The UpdateOrderStatus API lets you cancel an order with a reason (and
        notify the customer accordingly) or move an order to a processing status
        (used by Global‑e or specific cases not covered in this guide). This
        guide focuses on cancelling orders prior to dispatch.
      operationId: updateOrderStatus
      parameters:
        - name: orderStatus
          in: query
          required: true
          description: >-
            The request payload, as a **URL-encoded, JSON-serialized
            `OrderStatusDetails` object** — passed in the query string, **not**
            as a request body. Only `OrderId` is required. See the integration
            guide for the object's fields.
          schema:
            type: string
            example: >-
              {"OrderId":"GE1235436GB","OrderStatus":{"OrderStatusCode":"cancelled","Name":"cancelled"},"OrderStatusReason":{"OrderStatusReasonCode":"1010","Name":"CustomerCancel"}}
      responses:
        '200':
          description: >-
            Success or failure. Check the `Success` field to distinguish. On
            failure, `Message` and `Description` carry the error text.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseInfo'
              examples:
                success:
                  summary: Success
                  value:
                    Success: true
                failure:
                  summary: Failure
                  value:
                    Success: false
                    Message: error message
                    Description: error description
      x-codeSamples:
        - lang: cURL
          source: |-
            curl --request POST \
              --url 'https://{globale_api_domain}/Order/UpdateOrderStatus?orderStatus={"OrderId":"GE1235436GB","OrderStatus":{"OrderStatusCode":"cancelled","Name":"cancelled"},"OrderStatusReason":{"OrderStatusReasonCode":"1010","Name":"CustomerCancel"}}'
components:
  schemas:
    ResponseInfo:
      type: object
      title: ResponseInfo
      description: Indicates if the API call was successful or not, and why.
      properties:
        Success:
          type: boolean
          description: >-
            Indicates if the call has succeeded. TRUE - Call succeeded. FALSE -
            Denotes an error or failure.
        Message:
          type: string
          description: >-
            Optional response message. In case of an error, this property
            indicates the error message text.
        Description:
          type: string
          description: >-
            Optional response description. In case of an error, this property
            indicates the error message description.
        ErrorCode:
          type: string
          description: Error code to be returned when an error occurs.
        InternalOrderId:
          type: string
          description: Order unique identifier on the Merchant's site.
        OrderId:
          type: string
          description: >-
            Order identifier on the Merchant's site used for display and
            reporting purposes only. Unlike the InternalOrderId, this identifier
            is not necessarily unique over time, as the Merchant's site may
            potentially reuse it (for example after deleting the old order
            having the same OrderId).
        PaymentAmount:
          type: string
          description: >-
            The total payment amount in PaymentCurrency charged for the order
            (if payment was processed in the respective API method call).
        PaymentCurrencyCode:
          type: string
          description: >-
            3-char ISO currency code for the order (if payment was processed in
            the respective API method call).
        StatusCode:
          type: string
          description: >-
            Code denoting the order status on the Merchant's site (to be mapped
            on the Global‑e side).

````