POST api/order/add

Request Information

URI Parameters

None.

Body Parameters

ExigoOrderCreateDto
NameDescriptionTypeAdditional information
CustomerID

integer

None.

CustomerKey

string

None.

OrderDate

date

None.

CurrencyCode

string

None.

OrderStatus

string

None.

OrderType

string

None.

PriceType

integer

None.

WarehouseID

integer

None.

ShipMethodID

integer

None.

IsCommissionable

boolean

None.

Notes

string

None.

ReturnOrderID

integer

None.

Shipping

decimal number

None.

HandlingFee

decimal number

None.

ShippingStateTax

decimal number

None.

ShippingFedTax

decimal number

None.

ShippingCityTax

decimal number

None.

ShippingCityLocalTax

decimal number

None.

ShippingCountyTax

decimal number

None.

ShippingCountyLocalTax

decimal number

None.

ManualOrderKey

string

None.

ExistingOrderKey

string

None.

OverwriteExistingOrder

boolean

None.

ShipTo

ExigoOrderShipToDto

None.

ReferenceFields

ExigoOrderReferenceFieldsDto

None.

Lines

Collection of ExigoOrderLineDto

None.

localization

string

None.

Request Formats

application/json, text/json

Sample:
{
  "CustomerID": 1,
  "CustomerKey": "sample string 2",
  "OrderDate": "2026-11-16T12:37:13.4743836-06:00",
  "CurrencyCode": "sample string 3",
  "OrderStatus": "sample string 4",
  "OrderType": "sample string 5",
  "PriceType": 1,
  "WarehouseID": 1,
  "ShipMethodID": 1,
  "IsCommissionable": true,
  "Notes": "sample string 6",
  "ReturnOrderID": 1,
  "Shipping": 1.0,
  "HandlingFee": 1.0,
  "ShippingStateTax": 1.0,
  "ShippingFedTax": 1.0,
  "ShippingCityTax": 1.0,
  "ShippingCityLocalTax": 1.0,
  "ShippingCountyTax": 1.0,
  "ShippingCountyLocalTax": 1.0,
  "ManualOrderKey": "sample string 7",
  "ExistingOrderKey": "sample string 8",
  "OverwriteExistingOrder": true,
  "ShipTo": {
    "FirstName": "sample string 1",
    "LastName": "sample string 2",
    "Company": "sample string 3",
    "Phone": "sample string 4",
    "Email": "sample string 5",
    "Address1": "sample string 6",
    "Address2": "sample string 7",
    "Address3": "sample string 8",
    "City": "sample string 9",
    "State": "sample string 10",
    "Zip": "sample string 11",
    "County": "sample string 12",
    "Country": "sample string 13",
    "Verified": true
  },
  "ReferenceFields": {
    "Other11": "sample string 1",
    "Other12": "sample string 2",
    "Other13": "sample string 3",
    "Other14": "sample string 4",
    "Other15": "sample string 5",
    "Other16": "sample string 6",
    "Other17": "sample string 7",
    "Other18": "sample string 8",
    "Other19": "sample string 9",
    "Other20": "sample string 10"
  },
  "Lines": [
    {
      "ItemCode": "sample string 1",
      "Qty": 2.0,
      "PriceEach": 1.0,
      "TaxablePriceEach": 1.0,
      "Description": "sample string 3",
      "ParentItemCode": "sample string 4",
      "Reference1": "sample string 5",
      "CVEach": 1.0,
      "BVEach": 1.0,
      "WeightEach": 1.0,
      "FedTax": 1.0,
      "StateTax": 1.0,
      "CityTax": 1.0,
      "CountyTax": 1.0,
      "CountyLocalTax": 1.0,
      "OtherAmounts": {
        "Other1Each": 1.0,
        "Other2Each": 1.0,
        "Other3Each": 1.0,
        "Other4Each": 1.0,
        "Other5Each": 1.0,
        "Other6Each": 1.0,
        "Other7Each": 1.0,
        "Other8Each": 1.0,
        "Other9Each": 1.0,
        "Other10Each": 1.0
      }
    },
    {
      "ItemCode": "sample string 1",
      "Qty": 2.0,
      "PriceEach": 1.0,
      "TaxablePriceEach": 1.0,
      "Description": "sample string 3",
      "ParentItemCode": "sample string 4",
      "Reference1": "sample string 5",
      "CVEach": 1.0,
      "BVEach": 1.0,
      "WeightEach": 1.0,
      "FedTax": 1.0,
      "StateTax": 1.0,
      "CityTax": 1.0,
      "CountyTax": 1.0,
      "CountyLocalTax": 1.0,
      "OtherAmounts": {
        "Other1Each": 1.0,
        "Other2Each": 1.0,
        "Other3Each": 1.0,
        "Other4Each": 1.0,
        "Other5Each": 1.0,
        "Other6Each": 1.0,
        "Other7Each": 1.0,
        "Other8Each": 1.0,
        "Other9Each": 1.0,
        "Other10Each": 1.0
      }
    }
  ],
  "localization": "sample string 9"
}

application/xml, text/xml

Sample:
<ExigoOrderCreateDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Neora.Services.Model.DTO">
  <localization>sample string 9</localization>
  <CurrencyCode>sample string 3</CurrencyCode>
  <CustomerID>1</CustomerID>
  <CustomerKey>sample string 2</CustomerKey>
  <ExistingOrderKey>sample string 8</ExistingOrderKey>
  <HandlingFee>1</HandlingFee>
  <IsCommissionable>true</IsCommissionable>
  <Lines>
    <ExigoOrderLineDto>
      <BVEach>1</BVEach>
      <CVEach>1</CVEach>
      <CityTax>1</CityTax>
      <CountyLocalTax>1</CountyLocalTax>
      <CountyTax>1</CountyTax>
      <Description>sample string 3</Description>
      <FedTax>1</FedTax>
      <ItemCode>sample string 1</ItemCode>
      <OtherAmounts>
        <Other10Each>1</Other10Each>
        <Other1Each>1</Other1Each>
        <Other2Each>1</Other2Each>
        <Other3Each>1</Other3Each>
        <Other4Each>1</Other4Each>
        <Other5Each>1</Other5Each>
        <Other6Each>1</Other6Each>
        <Other7Each>1</Other7Each>
        <Other8Each>1</Other8Each>
        <Other9Each>1</Other9Each>
      </OtherAmounts>
      <ParentItemCode>sample string 4</ParentItemCode>
      <PriceEach>1</PriceEach>
      <Qty>2</Qty>
      <Reference1>sample string 5</Reference1>
      <StateTax>1</StateTax>
      <TaxablePriceEach>1</TaxablePriceEach>
      <WeightEach>1</WeightEach>
    </ExigoOrderLineDto>
    <ExigoOrderLineDto>
      <BVEach>1</BVEach>
      <CVEach>1</CVEach>
      <CityTax>1</CityTax>
      <CountyLocalTax>1</CountyLocalTax>
      <CountyTax>1</CountyTax>
      <Description>sample string 3</Description>
      <FedTax>1</FedTax>
      <ItemCode>sample string 1</ItemCode>
      <OtherAmounts>
        <Other10Each>1</Other10Each>
        <Other1Each>1</Other1Each>
        <Other2Each>1</Other2Each>
        <Other3Each>1</Other3Each>
        <Other4Each>1</Other4Each>
        <Other5Each>1</Other5Each>
        <Other6Each>1</Other6Each>
        <Other7Each>1</Other7Each>
        <Other8Each>1</Other8Each>
        <Other9Each>1</Other9Each>
      </OtherAmounts>
      <ParentItemCode>sample string 4</ParentItemCode>
      <PriceEach>1</PriceEach>
      <Qty>2</Qty>
      <Reference1>sample string 5</Reference1>
      <StateTax>1</StateTax>
      <TaxablePriceEach>1</TaxablePriceEach>
      <WeightEach>1</WeightEach>
    </ExigoOrderLineDto>
  </Lines>
  <ManualOrderKey>sample string 7</ManualOrderKey>
  <Notes>sample string 6</Notes>
  <OrderDate>2026-11-16T12:37:13.4743836-06:00</OrderDate>
  <OrderStatus>sample string 4</OrderStatus>
  <OrderType>sample string 5</OrderType>
  <OverwriteExistingOrder>true</OverwriteExistingOrder>
  <PriceType>1</PriceType>
  <ReferenceFields>
    <Other11>sample string 1</Other11>
    <Other12>sample string 2</Other12>
    <Other13>sample string 3</Other13>
    <Other14>sample string 4</Other14>
    <Other15>sample string 5</Other15>
    <Other16>sample string 6</Other16>
    <Other17>sample string 7</Other17>
    <Other18>sample string 8</Other18>
    <Other19>sample string 9</Other19>
    <Other20>sample string 10</Other20>
  </ReferenceFields>
  <ReturnOrderID>1</ReturnOrderID>
  <ShipMethodID>1</ShipMethodID>
  <ShipTo>
    <Address1>sample string 6</Address1>
    <Address2>sample string 7</Address2>
    <Address3>sample string 8</Address3>
    <City>sample string 9</City>
    <Company>sample string 3</Company>
    <Country>sample string 13</Country>
    <County>sample string 12</County>
    <Email>sample string 5</Email>
    <FirstName>sample string 1</FirstName>
    <LastName>sample string 2</LastName>
    <Phone>sample string 4</Phone>
    <State>sample string 10</State>
    <Verified>true</Verified>
    <Zip>sample string 11</Zip>
  </ShipTo>
  <Shipping>1</Shipping>
  <ShippingCityLocalTax>1</ShippingCityLocalTax>
  <ShippingCityTax>1</ShippingCityTax>
  <ShippingCountyLocalTax>1</ShippingCountyLocalTax>
  <ShippingCountyTax>1</ShippingCountyTax>
  <ShippingFedTax>1</ShippingFedTax>
  <ShippingStateTax>1</ShippingStateTax>
  <WarehouseID>1</WarehouseID>
</ExigoOrderCreateDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ExigoOrderCreateResponseDto
NameDescriptionTypeAdditional information
OrderID

integer

None.

OrderKey

string

None.

CustomerID

integer

None.

IsSuccess

boolean

None.

Message

string

None.

Messages

Collection of ErrorMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "Messages": [
    {
      "code": 1,
      "message": "sample string 2"
    },
    {
      "code": 1,
      "message": "sample string 2"
    }
  ],
  "OrderID": 1,
  "OrderKey": "sample string 2",
  "CustomerID": 3,
  "IsSuccess": true,
  "Message": "sample string 5"
}

application/xml, text/xml

Sample:
<ExigoOrderCreateResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Neora.Services.Model.DTO">
  <CustomerID>3</CustomerID>
  <IsSuccess>true</IsSuccess>
  <Message>sample string 5</Message>
  <Messages>
    <ErrorMessage>
      <code>1</code>
      <message>sample string 2</message>
    </ErrorMessage>
    <ErrorMessage>
      <code>1</code>
      <message>sample string 2</message>
    </ErrorMessage>
  </Messages>
  <OrderID>1</OrderID>
  <OrderKey>sample string 2</OrderKey>
</ExigoOrderCreateResponseDto>