POST order/{apiKey}/submit

Request Information

URI Parameters

Name	Description	Type	Additional information
apiKey		string	None.

Body Parameters

OrderRequestModel

Name	Type	Additional information
CompanyID	integer	None.
FirstName	string	Required
LastName	string	Required
Email	string	Required
Company	string	Required
Phone	string	None.
Fax	string	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
DistrictID	integer	None.
CountryID	integer	None.
PostCode	string	None.
SpecialInstructions	string	None.
Items	Collection of OrderItemModel	None.
Source	string	None.

Request Formats

application/json, text/json

Sample:

{
  "CompanyID": 1,
  "FirstName": "sample string 2",
  "LastName": "sample string 3",
  "Email": "sample string 4",
  "Company": "sample string 5",
  "Phone": "sample string 6",
  "Fax": "sample string 7",
  "AddressLine1": "sample string 8",
  "AddressLine2": "sample string 9",
  "City": "sample string 10",
  "DistrictID": 11,
  "CountryID": 12,
  "PostCode": "sample string 13",
  "SpecialInstructions": "sample string 14",
  "Items": [
    {
      "PartID": 1,
      "Quantity": 2,
      "StockNumber": "sample string 3",
      "Price": 4.0
    },
    {
      "PartID": 1,
      "Quantity": 2,
      "StockNumber": "sample string 3",
      "Price": 4.0
    }
  ],
  "Source": "sample string 15"
}

text/xml

Sample:

<OrderRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <AddressLine1>sample string 8</AddressLine1>
  <AddressLine2>sample string 9</AddressLine2>
  <City>sample string 10</City>
  <Company>sample string 5</Company>
  <CompanyID>1</CompanyID>
  <CountryID>12</CountryID>
  <DistrictID>11</DistrictID>
  <Email>sample string 4</Email>
  <Fax>sample string 7</Fax>
  <FirstName>sample string 2</FirstName>
  <Items>
    <OrderItemModel>
      <PartID>1</PartID>
      <Price>4</Price>
      <Quantity>2</Quantity>
      <StockNumber>sample string 3</StockNumber>
    </OrderItemModel>
    <OrderItemModel>
      <PartID>1</PartID>
      <Price>4</Price>
      <Quantity>2</Quantity>
      <StockNumber>sample string 3</StockNumber>
    </OrderItemModel>
  </Items>
  <LastName>sample string 3</LastName>
  <Phone>sample string 6</Phone>
  <PostCode>sample string 13</PostCode>
  <Source>sample string 15</Source>
  <SpecialInstructions>sample string 14</SpecialInstructions>
</OrderRequestModel>

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

Response Information

Resource Description

OrderSubmitResult

Name	Type	Additional information
reference_number	string	None.
count_of_items	integer	None.
quote_id	string	None.
status	string	None.
request_length	decimal number	None.
message	string	None.
ipaddress	string	None.

Response Formats

application/json, text/json

Sample:

{
  "reference_number": "sample string 1",
  "count_of_items": 2,
  "quote_id": "sample string 3",
  "status": "sample string 4",
  "request_length": 5.1,
  "message": "sample string 6",
  "ipaddress": "sample string 7"
}

text/xml

Sample:

<order_submit_result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPI.API.Models">
  <ipaddress>sample string 7</ipaddress>
  <message>sample string 6</message>
  <request_length>5.1</request_length>
  <status>sample string 4</status>
  <count_of_items>2</count_of_items>
  <quote_id>sample string 3</quote_id>
  <reference_number>sample string 1</reference_number>
</order_submit_result>