CustomOrder - POST

Create a new order using a raw XML or JSON request..

api/{role}/CustomOrder

Request Information

PropertyNoteTypeInfo
role string None

Model

PropertyNoteTypeInfo
DutiesPaid

Delivery Duty Paid

string Max length: 10
OrderItems

Collection of Order Line Items

Collection of IFSCustomOrderItemPOSTDTO None
OrderID

Your Order Identifier

string RequiredMax length: 50
Destination

Destination Shipping and Client Info

ShippingDestinationDTO None
GiftMessage

Gift Message

string Max length: 700
SpecialInstructions

Any Additional Instructions Needed To Process the Item

string None
GiftWrap

Determines whether Northwest Framing gift wraps the product. *This service is only available to select businesses

boolean None

Request Formats

application/json, text/json

{
  "dutiesPaid": "test 1",
  "orderItems": [
    {
      "itemNumber": "test 1",
      "quantity": 2,
      "description": "test 3",
      "retailPrice": 4.0,
      "thumbnailUrl": "test 5",
      "frameWidth": 6.0,
      "frameHeight": 7.0,
      "imageWidth": 8.0,
      "imageHeight": 9.0,
      "components": [
        {
          "componentID": "test 1",
          "inventoryType": 0,
          "layer": 2,
          "itemNumber": "test 3",
          "properties": [
            {
              "key": "test 1",
              "value": "test 2"
            },
            {
              "key": "test 1",
              "value": "test 2"
            }
          ]
        },
        {
          "componentID": "test 1",
          "inventoryType": 0,
          "layer": 2,
          "itemNumber": "test 3",
          "properties": [
            {
              "key": "test 1",
              "value": "test 2"
            },
            {
              "key": "test 1",
              "value": "test 2"
            }
          ]
        }
      ]
    },
    {
      "itemNumber": "test 1",
      "quantity": 2,
      "description": "test 3",
      "retailPrice": 4.0,
      "thumbnailUrl": "test 5",
      "frameWidth": 6.0,
      "frameHeight": 7.0,
      "imageWidth": 8.0,
      "imageHeight": 9.0,
      "components": [
        {
          "componentID": "test 1",
          "inventoryType": 0,
          "layer": 2,
          "itemNumber": "test 3",
          "properties": [
            {
              "key": "test 1",
              "value": "test 2"
            },
            {
              "key": "test 1",
              "value": "test 2"
            }
          ]
        },
        {
          "componentID": "test 1",
          "inventoryType": 0,
          "layer": 2,
          "itemNumber": "test 3",
          "properties": [
            {
              "key": "test 1",
              "value": "test 2"
            },
            {
              "key": "test 1",
              "value": "test 2"
            }
          ]
        }
      ]
    }
  ],
  "orderID": "test 2",
  "destination": {
    "shipVia": "test 1",
    "shippingMethod": "test 2",
    "address": {
      "name": "test 1",
      "name2": "test 2",
      "billToName": "test 3",
      "address1": "test 4",
      "address2": "test 5",
      "city": "test 6",
      "state": "test 7",
      "postal": "test 8",
      "country": "test 9",
      "phone": "test 10",
      "email": "test 11"
    }
  },
  "giftMessage": "test 3",
  "specialInstructions": "test 4",
  "giftWrap ": true
}

application/xml, text/xml

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
  <Destination>
    <Address>
      <Address1>test 4</Address1>
      <Address2>test 5</Address2>
      <BillToName>test 3</BillToName>
      <City>test 6</City>
      <Country>test 9</Country>
      <Email>test 11</Email>
      <Name>test 1</Name>
      <Name2>test 2</Name2>
      <Phone>test 10</Phone>
      <Postal>test 8</Postal>
      <State>test 7</State>
    </Address>
    <ShipVia>test 1</ShipVia>
    <ShippingMethod>test 2</ShippingMethod>
  </Destination>
  <GiftMessage>test 3</GiftMessage>
  <GiftWrap_x0020_>true</GiftWrap_x0020_>
  <OrderID>test 2</OrderID>
  <SpecialInstructions>test 4</SpecialInstructions>
  <DutiesPaid>test 1</DutiesPaid>
  <OrderItems>
    <OrderItem>
      <Components>
        <Component>
          <ComponentID>test 1</ComponentID>
          <InventoryType>Frame</InventoryType>
          <ItemNumber>test 3</ItemNumber>
          <Layer>2</Layer>
          <Properties>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
          </Properties>
        </Component>
        <Component>
          <ComponentID>test 1</ComponentID>
          <InventoryType>Frame</InventoryType>
          <ItemNumber>test 3</ItemNumber>
          <Layer>2</Layer>
          <Properties>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
          </Properties>
        </Component>
      </Components>
      <Description>test 3</Description>
      <FrameHeight>7</FrameHeight>
      <FrameWidth>6</FrameWidth>
      <ImageHeight>9</ImageHeight>
      <ImageWidth>8</ImageWidth>
      <ItemNumber>test 1</ItemNumber>
      <Quantity>2</Quantity>
      <RetailPrice>4</RetailPrice>
      <ThumbnailUrl>test 5</ThumbnailUrl>
    </OrderItem>
    <OrderItem>
      <Components>
        <Component>
          <ComponentID>test 1</ComponentID>
          <InventoryType>Frame</InventoryType>
          <ItemNumber>test 3</ItemNumber>
          <Layer>2</Layer>
          <Properties>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
          </Properties>
        </Component>
        <Component>
          <ComponentID>test 1</ComponentID>
          <InventoryType>Frame</InventoryType>
          <ItemNumber>test 3</ItemNumber>
          <Layer>2</Layer>
          <Properties>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
            <ComponentProperty>
              <Key>test 1</Key>
              <Value>test 2</Value>
            </ComponentProperty>
          </Properties>
        </Component>
      </Components>
      <Description>test 3</Description>
      <FrameHeight>7</FrameHeight>
      <FrameWidth>6</FrameWidth>
      <ImageHeight>9</ImageHeight>
      <ImageWidth>8</ImageWidth>
      <ItemNumber>test 1</ItemNumber>
      <Quantity>2</Quantity>
      <RetailPrice>4</RetailPrice>
      <ThumbnailUrl>test 5</ThumbnailUrl>
    </OrderItem>
  </OrderItems>
</Order>

Response Information

Collection of OrderImportResponseDTO
PropertyNoteTypeInfo
OrderNumber string None
ItemNumber string None
ImportID integer None
Success boolean None
Message string None

Response Formats

application/json, text/json

[
  {
    "orderNumber": "test 1",
    "itemNumber": "test 2",
    "importID": 1,
    "success": true,
    "message": "test 3"
  },
  {
    "orderNumber": "test 1",
    "itemNumber": "test 2",
    "importID": 1,
    "success": true,
    "message": "test 3"
  }
]

application/xml, text/xml

<ArrayOfOrderImportResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
  <OrderImportResponseDTO>
    <ImportID>1</ImportID>
    <ItemNumber>test 2</ItemNumber>
    <Message>test 3</Message>
    <OrderNumber>test 1</OrderNumber>
  </OrderImportResponseDTO>
  <OrderImportResponseDTO>
    <ImportID>1</ImportID>
    <ItemNumber>test 2</ItemNumber>
    <Message>test 3</Message>
    <OrderNumber>test 1</OrderNumber>
  </OrderImportResponseDTO>
</ArrayOfOrderImportResponseDTO>