Skip to main content
ORCA
MES
EN

Sales-order request

Register one sales order with the payload below.

Register the own mall as a sales channel before sending own-mall orders. Own mall sales channel guide →

Authentication

Copy the OPEN API key immediately after issuing it in Integration Management, store it as a server secret, and send it in the Bearer header. Put the sales channel ID copied from channel details in source_channel_id.

Authorization: Bearer <open-api-key>
Content-Type: application/json

Payload

{
  "source_type": "own_mall",
  "source_channel_id": "42",
  "external_order_id": "ORDER-2026-00042",
  "order_name": "Own mall ORDER-2026-00042",
  "ordered_at": "2026-08-18T00:00:00Z",
  "expected_delivery_at": "2026-08-22T00:00:00Z",
  "vendor_code": "ONLINE-CUSTOMER",
  "currency": "KRW",
  "shipping_address": "110 Sejong-daero, Seoul",
  "items": [
    {
      "item_code": "FINISHED-001",
      "quantity": 2,
      "unit_price": 12000
    }
  ]
}
FieldRequiredDescription
source_typeRequiredOrder source. Use own_mall for a custom store.
source_channel_idRequiredThe own-mall sales channel ID copied from channel details.
external_order_idRequiredThe store's order number.
order_nameOptionalThe sales-order name shown in ORCA.
ordered_atRequiredOrder date and time in ISO format, for example 2026-08-18T00:00:00Z.
expected_delivery_atRequiredDelivery date in ISO format.
vendor_codeRequiredA vendor code already registered in ORCA. The request fails if it is missing.
currencyRequiredCurrency code, for example KRW.
shipping_addressOptionalShipping address.
itemsRequiredSales-order items. At least one item is required.
items[].item_codeRequiredAn item code already registered in ORCA. The request fails if it is missing.
items[].quantityRequiredOrder quantity. Must be an integer of 1 or greater.
items[].unit_priceRequiredUnit price. Must be 0 or greater.

Call the sales-order API

const axios = require("axios");

const response = await axios.post(
  "https://open-api.orca.partners/v1/sales-orders",
  payload,
  {
    headers: {
      Authorization: "Bearer <open-api-key>",
      "Content-Type": "application/json",
    },
  }
);