POST api/order

Create a new order.

Request Information

Parameters

NameDescriptionAdditional information
createOrderRequest
The details of the order to create.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "ExternalOrderNumber": "b7988250",
  "PoNumber": "sample string 2",
  "OrderDate": "2021-12-07T17:17:20.634776-05:00",
  "OrderNotes": "sample string 4",
  "ShippingAddress": {
    "Name": "sample string 1",
    "Address1": "sample string 2",
    "Address2": "sample string 3",
    "Address3": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "ZipCode": "sample string 7",
    "Country": "sample string 8"
  },
  "ShipToPhoneNumber": "sample string 5",
  "ShipToEmailAddress": "sample string 6",
  "ShippingOptionId": 7,
  "DeliveryInstructions": "sample string 8",
  "SignatureRequired": true,
  "CreateOrderRequestLines": [
    {
      "Sku": "sample string 1",
      "Quantity": 2,
      "UnitOfMeasure": "sample string 3"
    },
    {
      "Sku": "sample string 1",
      "Quantity": 2,
      "UnitOfMeasure": "sample string 3"
    },
    {
      "Sku": "sample string 1",
      "Quantity": 2,
      "UnitOfMeasure": "sample string 3"
    }
  ],
  "PackingSlipType": "sample string 10"
}

application/xml, text/xml

Sample:
<CreateOrderRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ExternalOrderNumber>b7988250</ExternalOrderNumber>
  <PoNumber>sample string 2</PoNumber>
  <OrderDate>2021-12-07T17:17:20.634776-05:00</OrderDate>
  <OrderNotes>sample string 4</OrderNotes>
  <ShippingAddress>
    <Name>sample string 1</Name>
    <Address1>sample string 2</Address1>
    <Address2>sample string 3</Address2>
    <Address3>sample string 4</Address3>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <ZipCode>sample string 7</ZipCode>
    <Country>sample string 8</Country>
  </ShippingAddress>
  <ShipToPhoneNumber>sample string 5</ShipToPhoneNumber>
  <ShipToEmailAddress>sample string 6</ShipToEmailAddress>
  <ShippingOptionId>7</ShippingOptionId>
  <DeliveryInstructions>sample string 8</DeliveryInstructions>
  <SignatureRequired>true</SignatureRequired>
  <CreateOrderRequestLines>
    <CreateOrderRequestLine>
      <Sku>sample string 1</Sku>
      <Quantity>2</Quantity>
      <UnitOfMeasure>sample string 3</UnitOfMeasure>
    </CreateOrderRequestLine>
    <CreateOrderRequestLine>
      <Sku>sample string 1</Sku>
      <Quantity>2</Quantity>
      <UnitOfMeasure>sample string 3</UnitOfMeasure>
    </CreateOrderRequestLine>
    <CreateOrderRequestLine>
      <Sku>sample string 1</Sku>
      <Quantity>2</Quantity>
      <UnitOfMeasure>sample string 3</UnitOfMeasure>
    </CreateOrderRequestLine>
  </CreateOrderRequestLines>
  <PackingSlipType>sample string 10</PackingSlipType>
</CreateOrderRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

The id of the order request created in the system.

Response body formats

application/json, text/json

Sample:

Sample not available.