POST v1/partners/{partnerId}/stores/{storeId}/orders

Request Information

URI Parameters

NameDescriptionTypeAdditional information
partnerId

string

None.

storeId

string

None.

Body Parameters

LineDto
NameDescriptionTypeAdditional information
orderId

string

None.

orderShortCode

string

None.

restaurantRevenue

decimal number

None.

orderAcceptedTime

string

None.

items

Collection of LineItem

None.

additionalItems

Collection of AdditionalItem

None.

Request Formats

application/json, text/json

Sample:
{
  "orderId": "sample string 1",
  "orderShortCode": "sample string 2",
  "restaurantRevenue": 3.0,
  "orderAcceptedTime": "sample string 4",
  "items": [
    {
      "id": "sample string 1",
      "quantity": 2,
      "unitPrice": 3.0,
      "memo": "sample string 4",
      "promotionId": "sample string 5",
      "discount": 6.0,
      "properties": [
        {
          "id": "sample string 1",
          "values": [
            {
              "id": "sample string 1",
              "price": 2.0
            },
            {
              "id": "sample string 1",
              "price": 2.0
            }
          ]
        },
        {
          "id": "sample string 1",
          "values": [
            {
              "id": "sample string 1",
              "price": 2.0
            },
            {
              "id": "sample string 1",
              "price": 2.0
            }
          ]
        }
      ]
    },
    {
      "id": "sample string 1",
      "quantity": 2,
      "unitPrice": 3.0,
      "memo": "sample string 4",
      "promotionId": "sample string 5",
      "discount": 6.0,
      "properties": [
        {
          "id": "sample string 1",
          "values": [
            {
              "id": "sample string 1",
              "price": 2.0
            },
            {
              "id": "sample string 1",
              "price": 2.0
            }
          ]
        },
        {
          "id": "sample string 1",
          "values": [
            {
              "id": "sample string 1",
              "price": 2.0
            },
            {
              "id": "sample string 1",
              "price": 2.0
            }
          ]
        }
      ]
    }
  ],
  "additionalItems": [
    {
      "name": "sample string 1"
    },
    {
      "name": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:
<LineDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIIntegration.Models.Dto">
  <additionalItems>
    <AdditionalItem>
      <name>sample string 1</name>
    </AdditionalItem>
    <AdditionalItem>
      <name>sample string 1</name>
    </AdditionalItem>
  </additionalItems>
  <items>
    <LineItem>
      <discount>6</discount>
      <id>sample string 1</id>
      <memo>sample string 4</memo>
      <promotionId>sample string 5</promotionId>
      <properties>
        <LineProperty>
          <id>sample string 1</id>
          <values>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
          </values>
        </LineProperty>
        <LineProperty>
          <id>sample string 1</id>
          <values>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
          </values>
        </LineProperty>
      </properties>
      <quantity>2</quantity>
      <unitPrice>3</unitPrice>
    </LineItem>
    <LineItem>
      <discount>6</discount>
      <id>sample string 1</id>
      <memo>sample string 4</memo>
      <promotionId>sample string 5</promotionId>
      <properties>
        <LineProperty>
          <id>sample string 1</id>
          <values>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
          </values>
        </LineProperty>
        <LineProperty>
          <id>sample string 1</id>
          <values>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
            <Value>
              <id>sample string 1</id>
              <price>2</price>
            </Value>
          </values>
        </LineProperty>
      </properties>
      <quantity>2</quantity>
      <unitPrice>3</unitPrice>
    </LineItem>
  </items>
  <orderAcceptedTime>sample string 4</orderAcceptedTime>
  <orderId>sample string 1</orderId>
  <orderShortCode>sample string 2</orderShortCode>
  <restaurantRevenue>3</restaurantRevenue>
</LineDto>

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 'LineDto'.

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.