POST api/Manifests

Submit a completed ManifestDTO object to initiate a shipment.

Request Information

URI Parameters

None.

Body Parameters

The filled out manifest request should containing ALL of the customer information that you wish to send product to. Duplication detection will prevent resubmission of the same product for the same customer within a 24-hour window. Resubmission of identical details will return the same Receipt Number.

ManifestDTO
NameDescriptionTypeAdditional information
ReceiptNumber

This is the number returned when the order is accepted by the system.

 integer

None.
CompanyCode

The company code identifies the Company and Brand team that will be billed for the shipment.

 string

Required

String length: inclusive between 0 and 4
Name

The name of the end customer/company receiving the order.

 string

Required

String length: inclusive between 0 and 150
Email

The email address of the end user. The system will email this address with tracking information and compliance/completion notices.

 string

Required

String length: inclusive between 0 and 150
ProductSkuCode

The product SKU code of the item you will to ship to the customer. A list of products can be obtained from /api/Products.

 string

Required

String length: inclusive between 0 and 20
ShipToLine1

Ship to Line 1.

 string

Required

String length: inclusive between 0 and 150
ShipToLine2

Ship to Line 2.

 string

String length: inclusive between 0 and 150
ShipToLine3

Ship to Line 3.

 string

String length: inclusive between 0 and 150
Attention

The name of the person receiving the shipment. If left blank the Name field value is assumed.

 string

String length: inclusive between 0 and 100
City

Ship to City.

 string

Required

String length: inclusive between 0 and 50
State

Ship to State

 string

Required

String length: inclusive between 0 and 2
Zip5

Ship to Zip

 string

String length: inclusive between 0 and 5
Zip4

Ship to Zip4

 string

String length: inclusive between 0 and 4
OutboundTrackingNumber

The outbound tracking number of the order. This remains blank until the order has shipped.

 string

None.
ReturnTrackingNumber

The return tracking number of the order. This remains blank until the order has shipped.

 string

None.
ShippingStatus

The current shipping status of the order.

 string

None.
ReceivedAt

The date and time that the request was received.

 string

None.

Request Formats

application/json, text/json

Sample: 
{
  "ReceiptNumber": 1,
  "CompanyCode": "sample string 2",
  "Name": "sample string 3",
  "Email": "sample string 4",
  "ProductSkuCode": "sample string 5",
  "ShipToLine1": "sample string 6",
  "ShipToLine2": "sample string 7",
  "ShipToLine3": "sample string 8",
  "Attention": "sample string 9",
  "City": "sample string 10",
  "State": "sample string 11",
  "Zip5": "sample string 12",
  "Zip4": "sample string 13",
  "OutboundTrackingNumber": "sample string 14",
  "ReturnTrackingNumber": "sample string 15",
  "ShippingStatus": "sample string 16",
  "ReceivedAt": "sample string 17"
}

application/xml, text/xml

Sample: 
<ManifestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PureWayVendorApi.Models">
  <Attention>sample string 9</Attention>
  <City>sample string 10</City>
  <CompanyCode>sample string 2</CompanyCode>
  <Email>sample string 4</Email>
  <Name>sample string 3</Name>
  <OutboundTrackingNumber>sample string 14</OutboundTrackingNumber>
  <ProductSkuCode>sample string 5</ProductSkuCode>
  <ReceiptNumber>1</ReceiptNumber>
  <ReceivedAt>sample string 17</ReceivedAt>
  <ReturnTrackingNumber>sample string 15</ReturnTrackingNumber>
  <ShipToLine1>sample string 6</ShipToLine1>
  <ShipToLine2>sample string 7</ShipToLine2>
  <ShipToLine3>sample string 8</ShipToLine3>
  <ShippingStatus>sample string 16</ShippingStatus>
  <State>sample string 11</State>
  <Zip4>sample string 13</Zip4>
  <Zip5>sample string 12</Zip5>
</ManifestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.