# orderStatusUpdatedWebhook

Endpoint: POST order.status_updated
Version: 2.0.0
Security: BearerAuth

## Header parameters:

  - `x-hive-signature` (string, required)
    HMAC-SHA256 signature of the request body using your API token as the key

## Request fields (application/json):

  - `event_type` (string, required)
    The type of webhook event
    Enum: "order.status_updated"

  - `event_id` (string, required)
    Unique identifier for this webhook event

  - `timestamp` (string, required)
    When the event occurred

  - `data` (object, required)

  - `data.carrier_preference` (string,null, required)
    The preferred carrier to use for delivering this order

  - `data.currency` (string, required)
    3-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code.
Examples: EUR, USD, GBP, JPY

  - `data.custom_metadata` (object,null)
    A JSON object with custom metadata

  - `data.customer_order_number` (string,null)
    The order number which your customer sees. In case this is not the same as merchant_order_id.

  - `data.external_created_at` (string,null)
    When the order was originally created/placed by the customer. This can be different from created_at when doing bulk imports or when there's a delay between order placement and API submission.

  - `data.financial_status` (string, required)
    Financial status of this order. Possible values:
- failed: Payment failed
- paid: Payment completed successfully
- pending: Payment is pending
- refunded: Payment has been refunded
    Enum: "failed", "paid", "pending", "refunded"

  - `data.items` (array, required)
    List of items in the order (see OrderItem)

  - `data.items.merchant_item_id` (string, required)
    Identifier for the line item. Needs to be unique among the line items of the order.

  - `data.items.price_per_unit_in_cents` (integer)
    The price per unit of this item

  - `data.items.price_per_unit_in_cents_with_discount` (integer)
    The discounted price per unit of this item

  - `data.items.quantity` (integer, required)
    The quantity of this item in the order

  - `data.items.sku_code` (string)
    The merchant's SKU identifier - required if sku_id is not provided

  - `data.items.sku_id` (integer)
    Hive's SKU identifier - required if sku_code is not provided

  - `data.merchant_order_id` (string, required)
    An ID that uniquely identifies this order within the sales channel. Must be unique per sales channel.

  - `data.payment_method` (string,null)
    The payment method used for this order

  - `data.sales_channel_id` (integer, required)
    The ID of the sales channel this order belongs to

  - `data.shipping_address` (object, required)

  - `data.shipping_address.city` (string, required)
    City name

  - `data.shipping_address.company` (string,null)
    Company name

  - `data.shipping_address.country_code` (string, required)
    2-letter [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code.
Examples: DE, US, FR, NL

  - `data.shipping_address.email` (string,null)
    Email address

  - `data.shipping_address.first_name` (string,null)
    Customer's first name - required if last_name and full_name are omitted

  - `data.shipping_address.full_name` (string,null)
    Customer's full name - required if first_name and last_name are omitted

  - `data.shipping_address.last_name` (string,null)
    Customer's last name - required if first_name and full_name are omitted

  - `data.shipping_address.line1` (string, required)
    Customer's address line 1

  - `data.shipping_address.line2` (string,null)
    Customer's address line 2

  - `data.shipping_address.parcel_point_id` (string,null)
    Parcel point ID - see [Sendcloud service points](https://api.sendcloud.dev/docs/sendcloud-public-api/branches/v2/service-points)

  - `data.shipping_address.phone` (string,null)
    Customer's phone number

  - `data.shipping_address.postal_code` (string, required)
    Customer's postal code

  - `data.shipping_address.province_or_state_code` (string,null)
    State or province code. For US addresses, this should be the 2-letter state code (e.g., CA, NY, TX).
For other countries, this should be the appropriate province/state/region code.
Examples: CA (California), NY (New York), ON (Ontario), BE (Berlin)

  - `data.tags` (array,null)
    String tags for this order

  - `data.total_net_refunds_in_cents` (integer, required)
    Net refunds in cents (total refunded minus taxes)

  - `data.total_net_revenue_in_cents` (integer, required)
    Net revenue in cents (amount paid minus taxes)

  - `data.total_price_in_cents` (integer, required)
    Total price paid in cents

  - `data.total_tax_in_cents` (integer, required)
    Total tax paid in cents

  - `data.total_tax_refunds_in_cents` (integer, required)
    Total tax in the refunded amount in cents


## Response 200 fields

## Response 422 fields