OrderBody - PUT

Update an order using a raw XML or JSON request.

api/{role}/OrderBody

Request Information

Property	Note	Constraints
role : string

Model

Property	Note	Constraints
OrderItems : Array<IFSOrderPUTItemDTO>	Order Items To UPDATE
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. Optional - This service requires advanced set-up	*Advanced Setup
SpecialInstructions : string	Any Additional Instructions Needed To Process the Item
GiftWrap : boolean	Determines whether Northwest Framing gift wraps the product. Optional - This feature requires advanced setup	*Advanced Setup
AdditionalDocuments : Array<string>	Array of accessible URLs each linking to an additional document to be downloaded with order optional This feature requires advanced setup	*Advanced Setup

Request Formats

application/json, text/json

{
  "orderItems": [
    {
      "specialInstructions": "test 1",
      "itemID": "test 2"
    },
    {
      "specialInstructions": "test 1",
      "itemID": "test 2"
    }
  ],
  "orderID": "test 1",
  "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 2",
  "specialInstructions": "test 3",
  "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 2</GiftMessage>
  <GiftWrap>true</GiftWrap>
  <OrderID>test 1</OrderID>
  <SpecialInstructions>test 3</SpecialInstructions>
  <OrderItems>
    <OrderItem>
      <ItemID>test 2</ItemID>
      <SpecialInstructions>test 1</SpecialInstructions>
    </OrderItem>
    <OrderItem>
      <ItemID>test 2</ItemID>
      <SpecialInstructions>test 1</SpecialInstructions>
    </OrderItem>
  </OrderItems>
</Order>

Response Information

Array<GenericPutResponse>

Property	Note	Constraints
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>

Back To API Explorer