OrderBody - POST

Create a new order using a raw XML or JSON request. All SKU’s must be setup in our system prior to being submitted with an order. If an order is submitted with a SKU that isn’t on your list of SKU’s then it won’t be imported into our system.

api/{role}/OrderBody

Request Information

PropertyNoteTypeInfo
role string

none

Model

PropertyNoteTypeInfo
DutiesPaid

Duties Pay Type:

Options-- True: Indicates duties are paid by the sender

Options-- False(*default): Indicates duties are paid by the recipient (end user)

string

Max length: 10

OrderItems

Order Items To POST

Collection of IFSOrderPOSTItemDTO

Required

OrderID

Your Order Identifier

string

Required

Max 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

AdditionalDocuments

List of accessible URLs that point to additional documents to be downloaded with order

Collection of string

none

Request Formats

application/json, text/json

{
  "dutiesPaid": "test 1",
  "orderItems": [
    {
      "quantity": 1,
      "sku": "test 2",
      "description": "test 3",
      "retailPrice": 4.0,
      "topBorder": 5.1,
      "bottomBorder": 6.1,
      "leftBorder": 7.1,
      "rightBorder": 8.1,
      "images": [
        {
          "imageID": "test 1",
          "url": "test 2",
          "thumbnailURL": "test 3",
          "width": 4.1,
          "height": 5.1
        },
        {
          "imageID": "test 1",
          "url": "test 2",
          "thumbnailURL": "test 3",
          "width": 4.1,
          "height": 5.1
        }
      ],
      "itemID": "test 9"
    },
    {
      "quantity": 1,
      "sku": "test 2",
      "description": "test 3",
      "retailPrice": 4.0,
      "topBorder": 5.1,
      "bottomBorder": 6.1,
      "leftBorder": 7.1,
      "rightBorder": 8.1,
      "images": [
        {
          "imageID": "test 1",
          "url": "test 2",
          "thumbnailURL": "test 3",
          "width": 4.1,
          "height": 5.1
        },
        {
          "imageID": "test 1",
          "url": "test 2",
          "thumbnailURL": "test 3",
          "width": 4.1,
          "height": 5.1
        }
      ],
      "itemID": "test 9"
    }
  ],
  "orderID": "test 2",
  "destination": {
    "shipVia": "test 1",
    "shippingMethod": "test 2",
    "shippingAccount": "test 3",
    "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,
  "additionalDocuments": [
    "test 1",
    "test 2"
  ]
}

application/xml, text/xml

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
  <AdditionalDocuments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>test 1</d2p1:string>
    <d2p1:string>test 2</d2p1:string>
  </AdditionalDocuments>
  <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>
    <ShippingAccount>test 3</ShippingAccount>
    <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>
      <ItemID>test 9</ItemID>
      <BottomBorder>6.1</BottomBorder>
      <Description>test 3</Description>
      <Images>
        <Image>
          <Height>5.1</Height>
          <ImageID>test 1</ImageID>
          <ThumbnailURL>test 3</ThumbnailURL>
          <URL>test 2</URL>
          <Width>4.1</Width>
        </Image>
        <Image>
          <Height>5.1</Height>
          <ImageID>test 1</ImageID>
          <ThumbnailURL>test 3</ThumbnailURL>
          <URL>test 2</URL>
          <Width>4.1</Width>
        </Image>
      </Images>
      <LeftBorder>7.1</LeftBorder>
      <Quantity>1</Quantity>
      <RetailPrice>4</RetailPrice>
      <RightBorder>8.1</RightBorder>
      <SKU>test 2</SKU>
      <TopBorder>5.1</TopBorder>
    </OrderItem>
    <OrderItem>
      <ItemID>test 9</ItemID>
      <BottomBorder>6.1</BottomBorder>
      <Description>test 3</Description>
      <Images>
        <Image>
          <Height>5.1</Height>
          <ImageID>test 1</ImageID>
          <ThumbnailURL>test 3</ThumbnailURL>
          <URL>test 2</URL>
          <Width>4.1</Width>
        </Image>
        <Image>
          <Height>5.1</Height>
          <ImageID>test 1</ImageID>
          <ThumbnailURL>test 3</ThumbnailURL>
          <URL>test 2</URL>
          <Width>4.1</Width>
        </Image>
      </Images>
      <LeftBorder>7.1</LeftBorder>
      <Quantity>1</Quantity>
      <RetailPrice>4</RetailPrice>
      <RightBorder>8.1</RightBorder>
      <SKU>test 2</SKU>
      <TopBorder>5.1</TopBorder>
    </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>