OrdersFlat - PUT

Updates multiple orders using a flat (non-nested) request. 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

Required

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

BillToName : string

Max length: 50

GiftMessage : string

Gift Message

SpecialInstructions : string

Name of client to bill

GiftWrap : boolean

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

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",
    "billToName": "test 15",
    "giftMessage": "test 16",
    "specialInstructions": "test 17",
    "giftWrap": true
  },
  {
    "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",
    "billToName": "test 15",
    "giftMessage": "test 16",
    "specialInstructions": "test 17",
    "giftWrap": true
  }
]

application/xml, text/xml

<ArrayOfOrdersPUTDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS">
  <OrdersPUTDTO>
    <BillToName>test 15</BillToName>
    <GiftMessage>test 16</GiftMessage>
    <GiftWrap>true</GiftWrap>
    <ShipVia>test 13</ShipVia>
    <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 17</SpecialInstructions>
    <ItemNumber>test 2</ItemNumber>
    <OrderNumber>test 1</OrderNumber>
  </OrdersPUTDTO>
  <OrdersPUTDTO>
    <BillToName>test 15</BillToName>
    <GiftMessage>test 16</GiftMessage>
    <GiftWrap>true</GiftWrap>
    <ShipVia>test 13</ShipVia>
    <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 17</SpecialInstructions>
    <ItemNumber>test 2</ItemNumber>
    <OrderNumber>test 1</OrderNumber>
  </OrdersPUTDTO>
</ArrayOfOrdersPUTDTO>

Response Information

PropertyNoteConstraints
OrderNumber : string
ItemNumber : string
Error : string
Success : boolean
Message : string
ResponseID : integer
Status : PushStatus

Response Formats

application/json, text/json

[
  {
    "orderNumber": "test 1",
    "itemNumber": "test 2",
    "error": "test 3",
    "success": true,
    "message": "test 3",
    "responseID": 4,
    "status": 1
  },
  {
    "orderNumber": "test 1",
    "itemNumber": "test 2",
    "error": "test 3",
    "success": true,
    "message": "test 3",
    "responseID": 4,
    "status": 1
  }
]

application/xml, text/xml

<ArrayOfGenericPutResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FOTS.DTO">
  <GenericPutResponse>
    <ResponseID>4</ResponseID>
    <Error>test 3</Error>
    <ItemNumber>test 2</ItemNumber>
    <OrderNumber>test 1</OrderNumber>
  </GenericPutResponse>
  <GenericPutResponse>
    <ResponseID>4</ResponseID>
    <Error>test 3</Error>
    <ItemNumber>test 2</ItemNumber>
    <OrderNumber>test 1</OrderNumber>
  </GenericPutResponse>
</ArrayOfGenericPutResponse>