Creates an order. Hive fulfills it unless its destination country is blocked for the sales channel.
merchant_order_id must be unique within the sales channel. Sending one that already exists is answered with 409 Conflict, and the metadata.id of the error is the Hive ID of the existing order.
When the order was placed, as an ISO 8601 date-time. Must not be in the future; defaults to the current time.
The 3-letter ISO 4217 currency code of the order's amounts. Defaults to EUR.
The order number the customer sees, if it differs from merchant_order_id, which is the default.
The financial status of the order.
The order's line items. At least one is required, and each merchant_item_id must be unique within the order.
Your unique identifier for the order, unique within the sales channel.
The payment method of the order. For a Cash on Delivery order, send a value containing COD; total_price_in_cents must then be greater than 0, because it is the amount the carrier collects at delivery.
The order status to store. Leave it out; orders are created as fulfillable.
Refunds without tax, in cents. A string of digits is accepted too.
Revenue without tax, in cents. A string of digits is accepted too.
The total price paid, in cents. Required and greater than 0 for Cash on Delivery orders. A string of digits is accepted too.
The tax paid, in cents. A string of digits is accepted too.
- Mock serverhttps://hive-merchant-api.redocly.app/_mock/merchant-api-v1/mapi_v1_oas31/orders
- Production APIhttps://app.hive.app/merchant_api/v1/orders
- Staging APIhttps://staging.app.hive.app/merchant_api/v1/orders
curl -i -X POST \
https://hive-merchant-api.redocly.app/_mock/merchant-api-v1/mapi_v1_oas31/orders \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"merchant_order_id": "60423b95-23b5-4e5b-aa1c-6a71bd90b106",
"customer_order_number": "#1042",
"currency": "EUR",
"financial_status": "paid",
"total_price_in_cents": 2500,
"tags": [
"first_order"
],
"shipping_address": {
"first_name": "John",
"last_name": "Doe",
"full_name": "John Doe",
"line1": "Kassaveti 69",
"city": "Volos",
"country_code": "GR",
"postal_code": "38221"
},
"items": [
{
"merchant_item_id": "1",
"merchant_sku_id": "28595522549341",
"quantity": 1,
"price_per_unit_in_cents": 2500
}
]
}'The created order
When the order was placed, as sent by the merchant; the time Hive received it if none was sent.
The 3-letter ISO 4217 currency code of the order's amounts.
The order number the customer sees; the merchant_order_id when none was sent.
The financial status of the order.
The order's line items, including items cancelled by an update.
The merchant's unique identifier for the order, unique within the sales channel.
The payment method of the order. COD marks a Cash on Delivery order.
The order status:
fulfillable: Hive will fulfill the order. Orders created through the API are fulfillable by default.unfulfillable: Hive will not fulfill the order, for example because it was cancelled or its destination country is blocked for the sales channel.fulfilled: the order is fulfilled.on_hold: fulfillment of the order is on hold.
Revenue without tax (amount paid minus tax), in cents.
{ "id": 4962, "merchant_order_id": "60423b95-23b5-4e5b-aa1c-6a71bd90b106", "customer_order_number": "#1042", "status": "fulfillable", "carrier_preference": null, "created_at": "2022-11-01T17:42:07.409+01:00", "currency": "EUR", "financial_status": "paid", "payment_method": null, "total_price_in_cents": 2500, "total_net_revenue_in_cents": 2101, "total_tax_in_cents": 399, "total_net_refunds_in_cents": 0, "total_tax_refunds_in_cents": 0, "tags": [ "first_order" ], "shipping_address": { "first_name": "John", "last_name": "Doe", "full_name": "John Doe", "email": "john.doe@example.com", "phone": null, "company": null, "line1": "Kassaveti 69", "line2": null, "city": "Volos", "country_code": "GR", "postal_code": "38221", "parcel_point_id": null, "province_or_state_code": null }, "items": [ { … } ], "custom_metadata": null }