POST api/CustomerOrder?SessionID={SessionID}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SessionID

string

Required

Body Parameters

CustomerOrderInfoObject
NameDescriptionTypeAdditional information
CustomerOrderID

string

None.

OrderDate

date

None.

OrderStatus

decimal number

None.

PlacedByMethod

string

None.

PaymentTerms

string

None.

DeliveryDate

date

None.

DeliveryOrder

integer

None.

DeliveryDriver

string

None.

DeliveredToName

string

None.

DeliveryFee

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerOrderID": "sample string 1",
  "OrderDate": "2025-12-09T18:47:32.2558699-08:00",
  "OrderStatus": 3.0,
  "PlacedByMethod": "sample string 4",
  "PaymentTerms": "sample string 5",
  "DeliveryDate": "2025-12-09T18:47:32.2558699-08:00",
  "DeliveryOrder": 7,
  "DeliveryDriver": "sample string 8",
  "DeliveredToName": "sample string 9",
  "DeliveryFee": 10.0
}

application/xml, text/xml

Sample:
<CustomerOrderController.CustomerOrderInfoObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileAPI">
  <CustomerOrderID>sample string 1</CustomerOrderID>
  <DeliveredToName>sample string 9</DeliveredToName>
  <DeliveryDate>2025-12-09T18:47:32.2558699-08:00</DeliveryDate>
  <DeliveryDriver>sample string 8</DeliveryDriver>
  <DeliveryFee>10</DeliveryFee>
  <DeliveryOrder>7</DeliveryOrder>
  <OrderDate>2025-12-09T18:47:32.2558699-08:00</OrderDate>
  <OrderStatus>3</OrderStatus>
  <PaymentTerms>sample string 5</PaymentTerms>
  <PlacedByMethod>sample string 4</PlacedByMethod>
</CustomerOrderController.CustomerOrderInfoObject>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomerOrderReturnObj
NameDescriptionTypeAdditional information
ReturnCode

integer

None.

ReturnMessage

string

None.

OrderInformation

OrderObject

None.

Response Formats

application/json, text/json

Sample:
{
  "ReturnCode": 1,
  "ReturnMessage": "sample string 2",
  "OrderInformation": {
    "CustomerOrderID": "sample string 1",
    "OrderDate": "sample string 2",
    "OrderNumber": "sample string 3",
    "InvoiceNumber": "sample string 4",
    "OrderStatus": "sample string 5",
    "LocationName": "sample string 6",
    "LocationAddress1": "sample string 7",
    "LocationAddress2": "sample string 8",
    "LocationCity": "sample string 9",
    "LocationState": "sample string 10",
    "LocationZipCode": "sample string 11",
    "LocationPhone": "sample string 12",
    "UserFirstName": "sample string 13",
    "UserLastName": "sample string 14",
    "PlacedByMethod": "sample string 15",
    "PaymentTerms": "sample string 16",
    "ProductTotal": 17.0,
    "DeliveryFee": 18.0,
    "SalesTax": 19.0,
    "OrderTotal": 20.0,
    "DeliveryDate": "sample string 21",
    "DeliveryOrder": 22,
    "DeliveryDriver": "sample string 23",
    "DeliveredToName": "sample string 24",
    "Details": [
      {
        "ProductName": "sample string 1",
        "ProductNumber": "sample string 2",
        "ProductDescription": "sample string 3",
        "OrderQty": 4,
        "UnitPrice": 5.0,
        "DeliveredQty": 6
      },
      {
        "ProductName": "sample string 1",
        "ProductNumber": "sample string 2",
        "ProductDescription": "sample string 3",
        "OrderQty": 4,
        "UnitPrice": 5.0,
        "DeliveredQty": 6
      }
    ],
    "Payments": [
      {
        "PaymentDate": "sample string 1",
        "Amount": 2.0,
        "PaymentMethod": "sample string 3"
      },
      {
        "PaymentDate": "sample string 1",
        "Amount": 2.0,
        "PaymentMethod": "sample string 3"
      }
    ]
  }
}

application/xml, text/xml

Sample:
<CustomerOrderController.CustomerOrderReturnObj xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileAPI">
  <OrderInformation>
    <CustomerOrderID>sample string 1</CustomerOrderID>
    <DeliveredToName>sample string 24</DeliveredToName>
    <DeliveryDate>sample string 21</DeliveryDate>
    <DeliveryDriver>sample string 23</DeliveryDriver>
    <DeliveryFee>18</DeliveryFee>
    <DeliveryOrder>22</DeliveryOrder>
    <Details>
      <OrderDetailObject>
        <DeliveredQty>6</DeliveredQty>
        <OrderQty>4</OrderQty>
        <ProductDescription>sample string 3</ProductDescription>
        <ProductName>sample string 1</ProductName>
        <ProductNumber>sample string 2</ProductNumber>
        <UnitPrice>5</UnitPrice>
      </OrderDetailObject>
      <OrderDetailObject>
        <DeliveredQty>6</DeliveredQty>
        <OrderQty>4</OrderQty>
        <ProductDescription>sample string 3</ProductDescription>
        <ProductName>sample string 1</ProductName>
        <ProductNumber>sample string 2</ProductNumber>
        <UnitPrice>5</UnitPrice>
      </OrderDetailObject>
    </Details>
    <InvoiceNumber>sample string 4</InvoiceNumber>
    <LocationAddress1>sample string 7</LocationAddress1>
    <LocationAddress2>sample string 8</LocationAddress2>
    <LocationCity>sample string 9</LocationCity>
    <LocationName>sample string 6</LocationName>
    <LocationPhone>sample string 12</LocationPhone>
    <LocationState>sample string 10</LocationState>
    <LocationZipCode>sample string 11</LocationZipCode>
    <OrderDate>sample string 2</OrderDate>
    <OrderNumber>sample string 3</OrderNumber>
    <OrderStatus>sample string 5</OrderStatus>
    <OrderTotal>20</OrderTotal>
    <PaymentTerms>sample string 16</PaymentTerms>
    <Payments>
      <OrderPaymentObject>
        <Amount>2</Amount>
        <PaymentDate>sample string 1</PaymentDate>
        <PaymentMethod>sample string 3</PaymentMethod>
      </OrderPaymentObject>
      <OrderPaymentObject>
        <Amount>2</Amount>
        <PaymentDate>sample string 1</PaymentDate>
        <PaymentMethod>sample string 3</PaymentMethod>
      </OrderPaymentObject>
    </Payments>
    <PlacedByMethod>sample string 15</PlacedByMethod>
    <ProductTotal>17</ProductTotal>
    <SalesTax>19</SalesTax>
    <UserFirstName>sample string 13</UserFirstName>
    <UserLastName>sample string 14</UserLastName>
  </OrderInformation>
  <ReturnCode>1</ReturnCode>
  <ReturnMessage>sample string 2</ReturnMessage>
</CustomerOrderController.CustomerOrderReturnObj>