POST order/createOrder

Request Information

URI Parameters

None.

Body Parameters

OrderDataV2
NameDescriptionTypeAdditional information
id

string

None.

store_id

string

None.

currency

string

None.

region

string

None.

order_short_code

string

None.

status

string

None.

payment_method

string

None.

create_time

integer

None.

update_time

integer

None.

items

Collection of Item

None.

amount

Amount

None.

cancel

Cancel

None.

remark

string

None.

buyer

Buyer

None.

Request Formats

application/json, text/json

Sample:
{
  "id": "sample string 1",
  "store_id": "sample string 2",
  "currency": "sample string 3",
  "region": "sample string 4",
  "order_short_code": "sample string 5",
  "status": "sample string 6",
  "payment_method": "sample string 7",
  "create_time": 8,
  "update_time": 9,
  "items": [
    {
      "detail": {
        "dish": {
          "id": "sample string 1",
          "external_id": "sample string 2",
          "name": "sample string 3",
          "unit_list_price": 4.0,
          "unit_price": 5.0,
          "merchant_item_subsidy_amount": 6.0
        },
        "option_groups": [
          {
            "id": "sample string 1",
            "external_id": "sample string 2",
            "name": "sample string 3",
            "options": [
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              },
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              }
            ]
          },
          {
            "id": "sample string 1",
            "external_id": "sample string 2",
            "name": "sample string 3",
            "options": [
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              },
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              }
            ]
          }
        ]
      },
      "quantity": 1,
      "unit_price": 2.0,
      "unit_list_price": 3.0,
      "subtotal": 4.0,
      "remark": "sample string 5",
      "merchant_item_subsidy_amount": 6.0,
      "prepaid_voucher_amount": 7.0,
      "merchant_prepaid_voucher_subsidy_amount": 8.0
    },
    {
      "detail": {
        "dish": {
          "id": "sample string 1",
          "external_id": "sample string 2",
          "name": "sample string 3",
          "unit_list_price": 4.0,
          "unit_price": 5.0,
          "merchant_item_subsidy_amount": 6.0
        },
        "option_groups": [
          {
            "id": "sample string 1",
            "external_id": "sample string 2",
            "name": "sample string 3",
            "options": [
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              },
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              }
            ]
          },
          {
            "id": "sample string 1",
            "external_id": "sample string 2",
            "name": "sample string 3",
            "options": [
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              },
              {
                "id": "sample string 1",
                "external_id": "sample string 2",
                "name": "sample string 3",
                "price": 4.0
              }
            ]
          }
        ]
      },
      "quantity": 1,
      "unit_price": 2.0,
      "unit_list_price": 3.0,
      "subtotal": 4.0,
      "remark": "sample string 5",
      "merchant_item_subsidy_amount": 6.0,
      "prepaid_voucher_amount": 7.0,
      "merchant_prepaid_voucher_subsidy_amount": 8.0
    }
  ],
  "amount": {
    "subtotal": 1.0,
    "tax_amount": 2.0,
    "total_amount": 3.0,
    "merchant_service_fee": 4.0,
    "platform_service_fee": 5.0,
    "shipping_fee": 6.0,
    "shipping_basic_fee": 7.0,
    "shipping_surge_fee": 8.0,
    "merchant_surcharge_fee": 9.0,
    "small_order_fee": 10.0,
    "promotion": {
      "shipping_discount_amount": 1.0,
      "shipping_voucher_amount": 2.0,
      "item_discount_amount": 3.0,
      "item_voucher_amount": 4.0,
      "merchant_voucher_subsidy_amount": 5.0,
      "merchant_item_subsidy_amount": 6.0,
      "prepaid_voucher_amount": 7.0,
      "merchant_prepaid_voucher_subsidy_amount": 8.0
    },
    "unit_list_price_subtotal": 11.0
  },
  "cancel": {
    "cancel_reason": "sample string 1",
    "cancel_source": "sample string 2",
    "cancel_proposer": "sample string 3",
    "cancel_remark": "sample string 4"
  },
  "remark": "sample string 10",
  "buyer": {}
}

application/xml, text/xml

Sample:
<OrderDataV2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EIOS_Partner_Integration.Models">
  <amount>
    <merchant_service_fee>4</merchant_service_fee>
    <merchant_surcharge_fee>9</merchant_surcharge_fee>
    <platform_service_fee>5</platform_service_fee>
    <promotion>
      <item_discount_amount>3</item_discount_amount>
      <item_voucher_amount>4</item_voucher_amount>
      <merchant_item_subsidy_amount>6</merchant_item_subsidy_amount>
      <merchant_prepaid_voucher_subsidy_amount>8</merchant_prepaid_voucher_subsidy_amount>
      <merchant_voucher_subsidy_amount>5</merchant_voucher_subsidy_amount>
      <prepaid_voucher_amount>7</prepaid_voucher_amount>
      <shipping_discount_amount>1</shipping_discount_amount>
      <shipping_voucher_amount>2</shipping_voucher_amount>
    </promotion>
    <shipping_basic_fee>7</shipping_basic_fee>
    <shipping_fee>6</shipping_fee>
    <shipping_surge_fee>8</shipping_surge_fee>
    <small_order_fee>10</small_order_fee>
    <subtotal>1</subtotal>
    <tax_amount>2</tax_amount>
    <total_amount>3</total_amount>
    <unit_list_price_subtotal>11</unit_list_price_subtotal>
  </amount>
  <buyer />
  <cancel>
    <cancel_proposer>sample string 3</cancel_proposer>
    <cancel_reason>sample string 1</cancel_reason>
    <cancel_remark>sample string 4</cancel_remark>
    <cancel_source>sample string 2</cancel_source>
  </cancel>
  <create_time>8</create_time>
  <currency>sample string 3</currency>
  <id>sample string 1</id>
  <items>
    <Item>
      <detail>
        <dish>
          <external_id>sample string 2</external_id>
          <id>sample string 1</id>
          <merchant_item_subsidy_amount>6</merchant_item_subsidy_amount>
          <name>sample string 3</name>
          <unit_list_price>4</unit_list_price>
          <unit_price>5</unit_price>
        </dish>
        <option_groups>
          <OptionGroup2>
            <external_id>sample string 2</external_id>
            <id>sample string 1</id>
            <name>sample string 3</name>
            <options>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
            </options>
          </OptionGroup2>
          <OptionGroup2>
            <external_id>sample string 2</external_id>
            <id>sample string 1</id>
            <name>sample string 3</name>
            <options>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
            </options>
          </OptionGroup2>
        </option_groups>
      </detail>
      <merchant_item_subsidy_amount>6</merchant_item_subsidy_amount>
      <merchant_prepaid_voucher_subsidy_amount>8</merchant_prepaid_voucher_subsidy_amount>
      <prepaid_voucher_amount>7</prepaid_voucher_amount>
      <quantity>1</quantity>
      <remark>sample string 5</remark>
      <subtotal>4</subtotal>
      <unit_list_price>3</unit_list_price>
      <unit_price>2</unit_price>
    </Item>
    <Item>
      <detail>
        <dish>
          <external_id>sample string 2</external_id>
          <id>sample string 1</id>
          <merchant_item_subsidy_amount>6</merchant_item_subsidy_amount>
          <name>sample string 3</name>
          <unit_list_price>4</unit_list_price>
          <unit_price>5</unit_price>
        </dish>
        <option_groups>
          <OptionGroup2>
            <external_id>sample string 2</external_id>
            <id>sample string 1</id>
            <name>sample string 3</name>
            <options>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
            </options>
          </OptionGroup2>
          <OptionGroup2>
            <external_id>sample string 2</external_id>
            <id>sample string 1</id>
            <name>sample string 3</name>
            <options>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
              <Option>
                <external_id>sample string 2</external_id>
                <id>sample string 1</id>
                <name>sample string 3</name>
                <price>4</price>
              </Option>
            </options>
          </OptionGroup2>
        </option_groups>
      </detail>
      <merchant_item_subsidy_amount>6</merchant_item_subsidy_amount>
      <merchant_prepaid_voucher_subsidy_amount>8</merchant_prepaid_voucher_subsidy_amount>
      <prepaid_voucher_amount>7</prepaid_voucher_amount>
      <quantity>1</quantity>
      <remark>sample string 5</remark>
      <subtotal>4</subtotal>
      <unit_list_price>3</unit_list_price>
      <unit_price>2</unit_price>
    </Item>
  </items>
  <order_short_code>sample string 5</order_short_code>
  <payment_method>sample string 7</payment_method>
  <region>sample string 4</region>
  <remark>sample string 10</remark>
  <status>sample string 6</status>
  <store_id>sample string 2</store_id>
  <update_time>9</update_time>
</OrderDataV2>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'OrderDataV2'.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.