POST api/Order

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ShipTos		Collection of ShipTo	None.
Orders		Collection of Order	None.

Request Formats

application/json, text/json

Sample:

{
  "ShipTos": [
    {
      "Address": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8",
        "EmailAddress": "sample string 9",
        "Residential": "sample string 10",
        "Phone": "sample string 11"
      },
      "Items": [
        {
          "LineNumber": 1,
          "ShippingMethod": "sample string 1",
          "UPC": "sample string 2",
          "Qty": 3.0,
          "ItemPrice": 4.0
        },
        {
          "LineNumber": 1,
          "ShippingMethod": "sample string 1",
          "UPC": "sample string 2",
          "Qty": 3.0,
          "ItemPrice": 4.0
        }
      ]
    },
    {
      "Address": {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "Address1": "sample string 3",
        "Address2": "sample string 4",
        "City": "sample string 5",
        "State": "sample string 6",
        "PostalCode": "sample string 7",
        "Country": "sample string 8",
        "EmailAddress": "sample string 9",
        "Residential": "sample string 10",
        "Phone": "sample string 11"
      },
      "Items": [
        {
          "LineNumber": 1,
          "ShippingMethod": "sample string 1",
          "UPC": "sample string 2",
          "Qty": 3.0,
          "ItemPrice": 4.0
        },
        {
          "LineNumber": 1,
          "ShippingMethod": "sample string 1",
          "UPC": "sample string 2",
          "Qty": 3.0,
          "ItemPrice": 4.0
        }
      ]
    }
  ],
  "Orders": [
    {
      "BrandCode": "sample string 1",
      "OrderID": "sample string 2",
      "OrderDate": "2025-07-06T08:44:04.1578099-04:00",
      "ShipTos": [
        {
          "Address": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address1": "sample string 3",
            "Address2": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "PostalCode": "sample string 7",
            "Country": "sample string 8",
            "EmailAddress": "sample string 9",
            "Residential": "sample string 10",
            "Phone": "sample string 11"
          },
          "Items": [
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            },
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            }
          ]
        },
        {
          "Address": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address1": "sample string 3",
            "Address2": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "PostalCode": "sample string 7",
            "Country": "sample string 8",
            "EmailAddress": "sample string 9",
            "Residential": "sample string 10",
            "Phone": "sample string 11"
          },
          "Items": [
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            },
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            }
          ]
        }
      ]
    },
    {
      "BrandCode": "sample string 1",
      "OrderID": "sample string 2",
      "OrderDate": "2025-07-06T08:44:04.1578099-04:00",
      "ShipTos": [
        {
          "Address": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address1": "sample string 3",
            "Address2": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "PostalCode": "sample string 7",
            "Country": "sample string 8",
            "EmailAddress": "sample string 9",
            "Residential": "sample string 10",
            "Phone": "sample string 11"
          },
          "Items": [
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            },
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            }
          ]
        },
        {
          "Address": {
            "FirstName": "sample string 1",
            "LastName": "sample string 2",
            "Address1": "sample string 3",
            "Address2": "sample string 4",
            "City": "sample string 5",
            "State": "sample string 6",
            "PostalCode": "sample string 7",
            "Country": "sample string 8",
            "EmailAddress": "sample string 9",
            "Residential": "sample string 10",
            "Phone": "sample string 11"
          },
          "Items": [
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            },
            {
              "LineNumber": 1,
              "ShippingMethod": "sample string 1",
              "UPC": "sample string 2",
              "Qty": 3.0,
              "ItemPrice": 4.0
            }
          ]
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<OrderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HanoverAPI.Models">
  <Orders>
    <OrderRequest.Order>
      <BrandCode>sample string 1</BrandCode>
      <OrderDate>2025-07-06T08:44:04.1578099-04:00</OrderDate>
      <OrderID>sample string 2</OrderID>
      <ShipTos>
        <OrderRequest.ShipTo>
          <Address>
            <Address1>sample string 3</Address1>
            <Address2>sample string 4</Address2>
            <City>sample string 5</City>
            <Country>sample string 8</Country>
            <EmailAddress>sample string 9</EmailAddress>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
            <Phone>sample string 11</Phone>
            <PostalCode>sample string 7</PostalCode>
            <Residential>sample string 10</Residential>
            <State>sample string 6</State>
          </Address>
          <Items>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
          </Items>
        </OrderRequest.ShipTo>
        <OrderRequest.ShipTo>
          <Address>
            <Address1>sample string 3</Address1>
            <Address2>sample string 4</Address2>
            <City>sample string 5</City>
            <Country>sample string 8</Country>
            <EmailAddress>sample string 9</EmailAddress>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
            <Phone>sample string 11</Phone>
            <PostalCode>sample string 7</PostalCode>
            <Residential>sample string 10</Residential>
            <State>sample string 6</State>
          </Address>
          <Items>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
          </Items>
        </OrderRequest.ShipTo>
      </ShipTos>
    </OrderRequest.Order>
    <OrderRequest.Order>
      <BrandCode>sample string 1</BrandCode>
      <OrderDate>2025-07-06T08:44:04.1578099-04:00</OrderDate>
      <OrderID>sample string 2</OrderID>
      <ShipTos>
        <OrderRequest.ShipTo>
          <Address>
            <Address1>sample string 3</Address1>
            <Address2>sample string 4</Address2>
            <City>sample string 5</City>
            <Country>sample string 8</Country>
            <EmailAddress>sample string 9</EmailAddress>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
            <Phone>sample string 11</Phone>
            <PostalCode>sample string 7</PostalCode>
            <Residential>sample string 10</Residential>
            <State>sample string 6</State>
          </Address>
          <Items>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
          </Items>
        </OrderRequest.ShipTo>
        <OrderRequest.ShipTo>
          <Address>
            <Address1>sample string 3</Address1>
            <Address2>sample string 4</Address2>
            <City>sample string 5</City>
            <Country>sample string 8</Country>
            <EmailAddress>sample string 9</EmailAddress>
            <FirstName>sample string 1</FirstName>
            <LastName>sample string 2</LastName>
            <Phone>sample string 11</Phone>
            <PostalCode>sample string 7</PostalCode>
            <Residential>sample string 10</Residential>
            <State>sample string 6</State>
          </Address>
          <Items>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
            <OrderRequest.Item>
              <ItemPrice>4</ItemPrice>
              <LineNumber>1</LineNumber>
              <Qty>3</Qty>
              <ShippingMethod>sample string 1</ShippingMethod>
              <UPC>sample string 2</UPC>
            </OrderRequest.Item>
          </Items>
        </OrderRequest.ShipTo>
      </ShipTos>
    </OrderRequest.Order>
  </Orders>
  <ShipTos>
    <OrderRequest.ShipTo>
      <Address>
        <Address1>sample string 3</Address1>
        <Address2>sample string 4</Address2>
        <City>sample string 5</City>
        <Country>sample string 8</Country>
        <EmailAddress>sample string 9</EmailAddress>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 11</Phone>
        <PostalCode>sample string 7</PostalCode>
        <Residential>sample string 10</Residential>
        <State>sample string 6</State>
      </Address>
      <Items>
        <OrderRequest.Item>
          <ItemPrice>4</ItemPrice>
          <LineNumber>1</LineNumber>
          <Qty>3</Qty>
          <ShippingMethod>sample string 1</ShippingMethod>
          <UPC>sample string 2</UPC>
        </OrderRequest.Item>
        <OrderRequest.Item>
          <ItemPrice>4</ItemPrice>
          <LineNumber>1</LineNumber>
          <Qty>3</Qty>
          <ShippingMethod>sample string 1</ShippingMethod>
          <UPC>sample string 2</UPC>
        </OrderRequest.Item>
      </Items>
    </OrderRequest.ShipTo>
    <OrderRequest.ShipTo>
      <Address>
        <Address1>sample string 3</Address1>
        <Address2>sample string 4</Address2>
        <City>sample string 5</City>
        <Country>sample string 8</Country>
        <EmailAddress>sample string 9</EmailAddress>
        <FirstName>sample string 1</FirstName>
        <LastName>sample string 2</LastName>
        <Phone>sample string 11</Phone>
        <PostalCode>sample string 7</PostalCode>
        <Residential>sample string 10</Residential>
        <State>sample string 6</State>
      </Address>
      <Items>
        <OrderRequest.Item>
          <ItemPrice>4</ItemPrice>
          <LineNumber>1</LineNumber>
          <Qty>3</Qty>
          <ShippingMethod>sample string 1</ShippingMethod>
          <UPC>sample string 2</UPC>
        </OrderRequest.Item>
        <OrderRequest.Item>
          <ItemPrice>4</ItemPrice>
          <LineNumber>1</LineNumber>
          <Qty>3</Qty>
          <ShippingMethod>sample string 1</ShippingMethod>
          <UPC>sample string 2</UPC>
        </OrderRequest.Item>
      </Items>
    </OrderRequest.ShipTo>
  </ShipTos>
</OrderRequest>

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

Response Information

Resource Description

OrderResponse

Name	Description	Type	Additional information
status		Status	None.
result		Collection of OrderReceipt	None.

Response Formats

application/json, text/json

Sample:

{
  "status": {
    "type": "Info",
    "code": "sample string 1",
    "message": "sample string 2",
    "refCode": "sample string 3",
    "stackTrace": "sample string 4",
    "requestErrors": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    }
  },
  "result": [
    {
      "brandCode": "sample string 1",
      "orderID": "sample string 2",
      "UPC": "sample string 3",
      "statusCode": "Successful",
      "statusMessage": "sample string 4"
    },
    {
      "brandCode": "sample string 1",
      "orderID": "sample string 2",
      "UPC": "sample string 3",
      "statusCode": "Successful",
      "statusMessage": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<OrderModel.OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HanoverAPI.Models">
  <result>
    <OrderModel.OrderReceipt>
      <UPC>sample string 3</UPC>
      <brandCode>sample string 1</brandCode>
      <orderID>sample string 2</orderID>
      <statusCode>Successful</statusCode>
      <statusMessage>sample string 4</statusMessage>
    </OrderModel.OrderReceipt>
    <OrderModel.OrderReceipt>
      <UPC>sample string 3</UPC>
      <brandCode>sample string 1</brandCode>
      <orderID>sample string 2</orderID>
      <statusCode>Successful</statusCode>
      <statusMessage>sample string 4</statusMessage>
    </OrderModel.OrderReceipt>
  </result>
  <status>
    <code>sample string 1</code>
    <message>sample string 2</message>
    <refCode>sample string 3</refCode>
    <requestErrors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </requestErrors>
    <stackTrace>sample string 4</stackTrace>
    <type>Info</type>
  </status>
</OrderModel.OrderResponse>