OrdersFlat - POST

Creates multiple orders using a flat (non-nested) request body. It is recommended to use the Order Body method if you prefer a structured request..

api/{role}/OrdersFlat

Request Information

PropertyNoteConstraints
role : string

Model

PropertyNoteConstraints
OrderNumber : string

Your Order Number

Required

Max length: 50

ItemNumber : string

Order Item Index Each item in an order must have a unique identifier. If your company uses specific item ID's please use that, otherwise sequential numbering is acceptable

Required

Max length: 50

ShippingName1 : string

Shipping Name

Required

Max length: 50

ShippingName2 : string

Shipping Name Extended

Max length: 50

ShippingAddress1 : string

Shipping Address

Required

Max length: 255

ShippingAddress2 : string

Shipping Address Extended

Max length: 255

ShippingCity : string

Shipping City

Required

Max length: 50

ShippingState : string

Shipping State

Max length: 50

ShippingZip : string

Shipping Zip Code

Required

Max length: 50

ShippingCountry : string

Shipping Country

Max length: 50

ShippingPhone : string

Shipping Phone

Max length: 50

ShippingEmail : string

Shipping Email

Max length: 50

ShipVia : string

Carrier who does the shipping. Options: FedEx, USPS, UPS, DHL

Required

Max length: 10

ShippingMethod : string

Method Method used to ship.
Options-- FedEx: Ground, Home Delivery, 2 Day, 2 Day AM, Express Saver, Priority Overnight, First Overnight, International Priority, International Economy Options-- USPS: Priority Mail Options-- UPS: Ground, Next Day Air, Next Day Air Early A.M, Next Day Air Saver, 2nd Day Air A.M, 2nd Day Air, 3 Day Select, Express Critical, Worldwide Expedited, Worldwide Saver Options-- DHL: Express Worldwide

Required

Max length: 100

VendorSKU : string

Your item id for the part being ordered.

Required

Max length: 100

Quantity : integer

Quantity of items being ordered.

Description : string

Description of the item

Required

Max length: 255

ImageURI : string

Web address where the item can be retrieved.

GiftMessage : string

Gift Message

ThumbnailURI : string

Web address where item can be previewed.

Max length: 255

DutiesPayType : string

Duties Pay Type

Max length: 10

RetailValue : decimal number

Price of the item sold to the public

TopBorder : decimal number

Matboard Top Border Width (*If Applicable)

BottomBorder : decimal number

Matboard Bottom Border Width (*If Applicable)

LeftBorder : decimal number

Matboard Left Border Width (*If Applicable)

RightBorder : decimal number

Matboard Right Border Width (*If Applicable)

ImageID : string

Identifier to reference an image.

Max length: 255

BillToName : string

Name of client to bill

Max length: 50

ImageWidth : decimal number

Image width in inches

ImageHeight : decimal number

Image height in inches

SpecialInstructions : string

Special Instructions

GiftWrap : boolean
ShippingAccount : string
AdditionalDocuments : Array<string>

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

AdditionalDocumentsString : string
AdditionalDocumentsJson : string
Package : string

Identifier that determines items that are packaged with this item

_If left as null, then the default packaging will be applied to the end product _Use the "package" API endpoint to determine which packages are available for your role

Request Formats

application/json, text/json

[
  {
    "orderNumber": "test 1",
    "itemNumber": "test 2",
    "shippingName1": "test 3",
    "shippingName2": "test 4",
    "shippingAddress1": "test 5",
    "shippingAddress2": "test 6",
    "shippingCity": "test 7",
    "shippingState": "test 8",
    "shippingZip": "test 9",
    "shippingCountry": "test 10",
    "shippingPhone": "test 11",
    "shippingEmail": "test 12",
    "shipVia": "test 13",
    "shippingMethod": "test 14",
    "vendorSKU": "test 15",
    "quantity": 16,
    "description": "test 17",
    "imageURI": "test 18",
    "giftMessage": "test 19",
    "thumbnailURI": "test 20",
    "dutiesPayType": "test 21",
    "retailValue": 22.0,
    "topBorder": 23.1,
    "bottomBorder": 24.1,
    "leftBorder": 25.1,
    "rightBorder": 26.1,
    "imageID": "test 27",
    "billToName": "test 28",
    "imageWidth": 29.1,
    "imageHeight": 30.1,
    "specialInstructions": "test 31",
    "giftWrap": true,
    "shippingAccount": "test 33",
    "additionalDocuments": [
      "test 1",
      "test 2"
    ],
    "additionalDocumentsString": "test 1,test 2",
    "additionalDocumentsJson": "[\"test 1\",\"test 2\"]",
    "package": "test 34"
  },
  {
    "orderNumber": "test 1",
    "itemNumber": "test 2",
    "shippingName1": "test 3",
    "shippingName2": "test 4",
    "shippingAddress1": "test 5",
    "shippingAddress2": "test 6",
    "shippingCity": "test 7",
    "shippingState": "test 8",
    "shippingZip": "test 9",
    "shippingCountry": "test 10",
    "shippingPhone": "test 11",
    "shippingEmail": "test 12",
    "shipVia": "test 13",
    "shippingMethod": "test 14",
    "vendorSKU": "test 15",
    "quantity": 16,
    "description": "test 17",
    "imageURI": "test 18",
    "giftMessage": "test 19",
    "thumbnailURI": "test 20",
    "dutiesPayType": "test 21",
    "retailValue": 22.0,
    "topBorder": 23.1,
    "bottomBorder": 24.1,
    "leftBorder": 25.1,
    "rightBorder": 26.1,
    "imageID": "test 27",
    "billToName": "test 28",
    "imageWidth": 29.1,
    "imageHeight": 30.1,
    "specialInstructions": "test 31",
    "giftWrap": true,
    "shippingAccount": "test 33",
    "additionalDocuments": [
      "test 1",
      "test 2"
    ],
    "additionalDocumentsString": "test 1,test 2",
    "additionalDocumentsJson": "[\"test 1\",\"test 2\"]",
    "package": "test 34"
  }
]

application/xml, text/xml

<ArrayOfOrdersPostDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS">
  <OrdersPostDTO>
    <AdditionalDocuments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>test 1</d3p1:string>
      <d3p1:string>test 2</d3p1:string>
    </AdditionalDocuments>
    <BillToName>test 28</BillToName>
    <BottomBorder>24.1</BottomBorder>
    <Description>test 17</Description>
    <DutiesPayType>test 21</DutiesPayType>
    <GiftMessage>test 19</GiftMessage>
    <GiftWrap>true</GiftWrap>
    <ImageHeight>30.1</ImageHeight>
    <ImageID>test 27</ImageID>
    <ImageURI>test 18</ImageURI>
    <ImageWidth>29.1</ImageWidth>
    <ItemNumber>test 2</ItemNumber>
    <LeftBorder>25.1</LeftBorder>
    <Package>test 34</Package>
    <Quantity>16</Quantity>
    <RetailValue>22</RetailValue>
    <RightBorder>26.1</RightBorder>
    <ShipVia>test 13</ShipVia>
    <ShippingAccount>test 33</ShippingAccount>
    <ShippingAddress1>test 5</ShippingAddress1>
    <ShippingAddress2>test 6</ShippingAddress2>
    <ShippingCity>test 7</ShippingCity>
    <ShippingCountry>test 10</ShippingCountry>
    <ShippingEmail>test 12</ShippingEmail>
    <ShippingMethod>test 14</ShippingMethod>
    <ShippingName1>test 3</ShippingName1>
    <ShippingName2>test 4</ShippingName2>
    <ShippingPhone>test 11</ShippingPhone>
    <ShippingState>test 8</ShippingState>
    <ShippingZip>test 9</ShippingZip>
    <SpecialInstructions>test 31</SpecialInstructions>
    <ThumbnailURI>test 20</ThumbnailURI>
    <TopBorder>23.1</TopBorder>
    <VendorSKU>test 15</VendorSKU>
    <OrderNumber>test 1</OrderNumber>
  </OrdersPostDTO>
  <OrdersPostDTO>
    <AdditionalDocuments xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>test 1</d3p1:string>
      <d3p1:string>test 2</d3p1:string>
    </AdditionalDocuments>
    <BillToName>test 28</BillToName>
    <BottomBorder>24.1</BottomBorder>
    <Description>test 17</Description>
    <DutiesPayType>test 21</DutiesPayType>
    <GiftMessage>test 19</GiftMessage>
    <GiftWrap>true</GiftWrap>
    <ImageHeight>30.1</ImageHeight>
    <ImageID>test 27</ImageID>
    <ImageURI>test 18</ImageURI>
    <ImageWidth>29.1</ImageWidth>
    <ItemNumber>test 2</ItemNumber>
    <LeftBorder>25.1</LeftBorder>
    <Package>test 34</Package>
    <Quantity>16</Quantity>
    <RetailValue>22</RetailValue>
    <RightBorder>26.1</RightBorder>
    <ShipVia>test 13</ShipVia>
    <ShippingAccount>test 33</ShippingAccount>
    <ShippingAddress1>test 5</ShippingAddress1>
    <ShippingAddress2>test 6</ShippingAddress2>
    <ShippingCity>test 7</ShippingCity>
    <ShippingCountry>test 10</ShippingCountry>
    <ShippingEmail>test 12</ShippingEmail>
    <ShippingMethod>test 14</ShippingMethod>
    <ShippingName1>test 3</ShippingName1>
    <ShippingName2>test 4</ShippingName2>
    <ShippingPhone>test 11</ShippingPhone>
    <ShippingState>test 8</ShippingState>
    <ShippingZip>test 9</ShippingZip>
    <SpecialInstructions>test 31</SpecialInstructions>
    <ThumbnailURI>test 20</ThumbnailURI>
    <TopBorder>23.1</TopBorder>
    <VendorSKU>test 15</VendorSKU>
    <OrderNumber>test 1</OrderNumber>
  </OrdersPostDTO>
</ArrayOfOrdersPostDTO>

Response Information

Import ID

PropertyNoteConstraints
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>