POST api/Incoming/Order

This is the API for incoming order data save into 800degrees database

Request Information

URI Parameters

None.

Body Parameters

The model.

InComingOrderModel
NameDescriptionTypeAdditional information
externalIdentifiers

ExternalIdentifiers

None.

items

Collection of Item

None.

orderedAt

date

None.

currencyCode

string

None.

customer

Customer

None.

customerNote

string

None.

status

string

None.

deliveryInfo

Object

None.

orderTotal

OrderTotal

None.

customerPayments

Collection of CustomerPayment

None.

fulfillmentInfo

FulfillmentInfo

None.

Request Formats

application/json, text/json

Sample:
{
  "externalIdentifiers": {
    "id": "sample string 1",
    "friendlyId": "sample string 2",
    "source": {}
  },
  "items": [
    {
      "orderItemId": "sample string 1",
      "uuid": "sample string 2",
      "name": "sample string 3",
      "quantity": 4,
      "categoryId": "sample string 5",
      "categoryName": "sample string 6",
      "price": 1.0,
      "modifiers": [
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "quantity": 3,
          "price": 1.0,
          "groupName": "sample string 4",
          "groupId": "sample string 5"
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "quantity": 3,
          "price": 1.0,
          "groupName": "sample string 4",
          "groupId": "sample string 5"
        }
      ]
    },
    {
      "orderItemId": "sample string 1",
      "uuid": "sample string 2",
      "name": "sample string 3",
      "quantity": 4,
      "categoryId": "sample string 5",
      "categoryName": "sample string 6",
      "price": 1.0,
      "modifiers": [
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "quantity": 3,
          "price": 1.0,
          "groupName": "sample string 4",
          "groupId": "sample string 5"
        },
        {
          "id": "sample string 1",
          "name": "sample string 2",
          "quantity": 3,
          "price": 1.0,
          "groupName": "sample string 4",
          "groupId": "sample string 5"
        }
      ]
    }
  ],
  "orderedAt": "2024-07-02T01:42:51.1731536+00:00",
  "currencyCode": "sample string 2",
  "customer": {
    "name": "sample string 1",
    "phone": "sample string 2",
    "phoneCode": "sample string 3",
    "email": "sample string 4",
    "personalIdentifiers": {
      "taxIdentificationNumber": {}
    }
  },
  "customerNote": "sample string 3",
  "status": "sample string 4",
  "deliveryInfo": {},
  "orderTotal": {
    "subtotal": 1.0,
    "claimedSubtotal": 1.0,
    "discount": 1.0,
    "tax": 1.0,
    "tip": 1.0,
    "serviceFee": 1.0,
    "deliveryFee": 1.0,
    "total": 1.0,
    "couponCode": "sample string 1"
  },
  "customerPayments": [
    {
      "value": 1.1,
      "paymentMethod": "sample string 2",
      "processingStatus": "sample string 3"
    },
    {
      "value": 1.1,
      "paymentMethod": "sample string 2",
      "processingStatus": "sample string 3"
    }
  ],
  "fulfillmentInfo": {
    "pickupTime": "2024-07-02T01:42:51.1731536+00:00",
    "deliveryTime": {},
    "fulfillmentMode": "sample string 3",
    "schedulingType": "sample string 4",
    "courierStatus": "sample string 5"
  }
}

application/xml, text/xml

Sample:
<InComingOrderModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObject.ViewModel">
  <currencyCode>sample string 2</currencyCode>
  <customer>
    <email>sample string 4</email>
    <name>sample string 1</name>
    <personalIdentifiers>
      <taxIdentificationNumber />
    </personalIdentifiers>
    <phone>sample string 2</phone>
    <phoneCode>sample string 3</phoneCode>
  </customer>
  <customerNote>sample string 3</customerNote>
  <customerPayments>
    <CustomerPayment>
      <paymentMethod>sample string 2</paymentMethod>
      <processingStatus>sample string 3</processingStatus>
      <value>1.1</value>
    </CustomerPayment>
    <CustomerPayment>
      <paymentMethod>sample string 2</paymentMethod>
      <processingStatus>sample string 3</processingStatus>
      <value>1.1</value>
    </CustomerPayment>
  </customerPayments>
  <deliveryInfo />
  <externalIdentifiers>
    <friendlyId>sample string 2</friendlyId>
    <id>sample string 1</id>
    <source />
  </externalIdentifiers>
  <fulfillmentInfo>
    <courierStatus>sample string 5</courierStatus>
    <deliveryTime />
    <fulfillmentMode>sample string 3</fulfillmentMode>
    <pickupTime>2024-07-02T01:42:51.1731536+00:00</pickupTime>
    <schedulingType>sample string 4</schedulingType>
  </fulfillmentInfo>
  <items>
    <Item>
      <categoryId>sample string 5</categoryId>
      <categoryName>sample string 6</categoryName>
      <modifiers>
        <Modifier>
          <groupId>sample string 5</groupId>
          <groupName>sample string 4</groupName>
          <id>sample string 1</id>
          <name>sample string 2</name>
          <price>1</price>
          <quantity>3</quantity>
        </Modifier>
        <Modifier>
          <groupId>sample string 5</groupId>
          <groupName>sample string 4</groupName>
          <id>sample string 1</id>
          <name>sample string 2</name>
          <price>1</price>
          <quantity>3</quantity>
        </Modifier>
      </modifiers>
      <name>sample string 3</name>
      <orderItemId>sample string 1</orderItemId>
      <price>1</price>
      <quantity>4</quantity>
      <uuid>sample string 2</uuid>
    </Item>
    <Item>
      <categoryId>sample string 5</categoryId>
      <categoryName>sample string 6</categoryName>
      <modifiers>
        <Modifier>
          <groupId>sample string 5</groupId>
          <groupName>sample string 4</groupName>
          <id>sample string 1</id>
          <name>sample string 2</name>
          <price>1</price>
          <quantity>3</quantity>
        </Modifier>
        <Modifier>
          <groupId>sample string 5</groupId>
          <groupName>sample string 4</groupName>
          <id>sample string 1</id>
          <name>sample string 2</name>
          <price>1</price>
          <quantity>3</quantity>
        </Modifier>
      </modifiers>
      <name>sample string 3</name>
      <orderItemId>sample string 1</orderItemId>
      <price>1</price>
      <quantity>4</quantity>
      <uuid>sample string 2</uuid>
    </Item>
  </items>
  <orderTotal>
    <claimedSubtotal>1</claimedSubtotal>
    <couponCode>sample string 1</couponCode>
    <deliveryFee>1</deliveryFee>
    <discount>1</discount>
    <serviceFee>1</serviceFee>
    <subtotal>1</subtotal>
    <tax>1</tax>
    <tip>1</tip>
    <total>1</total>
  </orderTotal>
  <orderedAt>2024-07-02T01:42:51.1731536+00:00</orderedAt>
  <status>sample string 4</status>
</InComingOrderModel>

Response Information

Resource Description

APIResponseBaseOfString
NameDescriptionTypeAdditional information
StatusCode

integer

None.

IsSuccess

boolean

None.

Message

string

None.

Result

string

None.

Response Formats

application/json, text/json

Sample:
{
  "StatusCode": 1,
  "IsSuccess": true,
  "Message": "sample string 3",
  "Result": "sample string 4"
}

application/xml, text/xml

Sample:
<APIResponseBaseOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessObject.Other">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 3</Message>
  <Result>sample string 4</Result>
  <StatusCode>1</StatusCode>
</APIResponseBaseOfstring>