OrderBody - PUT

Update an order using a raw XML or JSON request.

api/{role}/OrderBody

Request Information

PropertyNoteTypeInfo
role string

none

Model

PropertyNoteTypeInfo
OrderItems

Order Items To UPDATE

Collection of IFSOrderPUTItemDTO

none

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

{
  "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_x0020_>true</GiftWrap_x0020_>
  <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

Collection of GenericPutResponse
PropertyNoteTypeInfo
OrderNumber string

none

ItemNumber string

none

Error string

none

Success boolean

none

Message string

none

ResponseID integer

none

Status PushStatus

none

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>