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
| Property | Note | Constraints |
|---|---|---|
| role : string |
Model
| Property | Note | Constraints |
|---|---|---|
| DutiesPaid : string |
Duties Pay Type: Options-- True: Indicates duties are paid by the sender Options-- False(*default): Indicates duties are paid by the recipient (end user) |
Max length: 10 |
| OrderItems : Array<IFSOrderPOSTItemDTO> |
Order Items To POST |
Required |
| OrderID : string |
Your Order Identifier |
Required Max length: 50 |
| Destination : ShippingDestinationDTO |
Destination Shipping and Client Info |
Required |
| GiftMessage : string |
A gift message to the recipient. |
*Advanced Setup |
| SpecialInstructions : string |
Any Additional Instructions Needed To Process the Item |
|
| GiftWrap : boolean |
Determines whether Northwest Framing gift wraps the product. |
*Advanced Setup |
| AdditionalDocuments : Array<string> |
Array of accessible URLs each linking to an additional document to be downloaded with order |
*Advanced Setup |
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
}
],
"package": "test 9",
"itemID": "test 10"
},
{
"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
}
],
"package": "test 9",
"itemID": "test 10"
}
],
"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>true</GiftWrap>
<OrderID>test 2</OrderID>
<SpecialInstructions>test 4</SpecialInstructions>
<DutiesPaid>test 1</DutiesPaid>
<OrderItems>
<OrderItem>
<ItemID>test 10</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>
<Package>test 9</Package>
<Quantity>1</Quantity>
<RetailPrice>4</RetailPrice>
<RightBorder>8.1</RightBorder>
<SKU>test 2</SKU>
<TopBorder>5.1</TopBorder>
</OrderItem>
<OrderItem>
<ItemID>test 10</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>
<Package>test 9</Package>
<Quantity>1</Quantity>
<RetailPrice>4</RetailPrice>
<RightBorder>8.1</RightBorder>
<SKU>test 2</SKU>
<TopBorder>5.1</TopBorder>
</OrderItem>
</OrderItems>
</Order>Response Information
Array<OrderImportResponseDTO>
| Property | Note | Constraints |
|---|---|---|
| OrderNumber : string | ||
| ItemNumber : string | ||
| ImportID : integer | ||
| Success : boolean | ||
| Message : string |
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>