POST api/Order/AttachFile?orderId={orderId}&fileTypeId={fileTypeId}&fileName={fileName}&fileNotes={fileNotes}

Attach a document or label to an order, allowing a custom file name to be specified. Expects multipart/form-data with a file.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderId

The WMS ID of the order to attach the file to.

integer

Required

fileTypeId

Allowable values: 1: Packing Slip, 2: Shipping Label, 3: Bill of Lading, 4: Freight Docs, 5: Commercial Invoice, 6: International Docs. PLEASE NOTE: Shipping Label, Commercial Invoice, and International Docs must all be in the .pdf format.

integer

Required

fileName

An optional user-defined name for the file (extension optional).

string

None.

fileNotes

An optional note or description for the attached file.

string

None.

Body Parameters

None.

Response Information

Resource Description

Returns a json string indicating success or failure.

BasicResponse
NameDescriptionTypeAdditional information
Message

Primary message for responses.

string

None.

MessageDetail

Additional information may be included in this field as needed.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Message": "sample string 1",
  "MessageDetail": "sample string 2"
}

application/xml, text/xml

Sample:
<BasicResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ISCAPI2.Models">
  <Message>sample string 1</Message>
  <MessageDetail>sample string 2</MessageDetail>
</BasicResponse>