POST api/ShipmentDocument?companyCode={companyCode}&types={types}&combinedPackList={combinedPackList}

Get Shipping Documents

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode	Company Identifier	string	Required
types	Comma separated list of requested types. Available options: zpl, png, pdf, packinglist	string	Required
combinedPackList	Combine Packing Lists	boolean	Required

Body Parameters

Shipment Reference Identifiers (barcodes)

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "string 1",
  "string 2"
]

application/xml, text/xml

Sample:

<ArrayOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <string>string 1</string>
  <string>string 2</string>
</ArrayOfString>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Response message with documents.HttpStatusCode.Conflict when user isn't connected to Company

GetShippingDocumentsMessageResponse

Name	Type	Additional information
Header	MessageHeader	None.
ShippingDocumentItems	Collection of ShippingDocumentItem	None.
Footer	MessageFooter	None.

Response Formats

application/json, text/json

Sample:

{
  "Header": {
    "Version": "string 1",
    "Identification": "string 2",
    "Sender": "string 3"
  },
  "ShippingDocumentItems": [
    {
      "CompanyIdentifier": "string 1",
      "CarrierReferenceID": "string 2",
      "Documents": [
        {
          "DocumentType": "LabelZPL",
          "DocumentName": "string 1",
          "DocumentData": "string 2"
        },
        {
          "DocumentType": "LabelZPL",
          "DocumentName": "string 1",
          "DocumentData": "string 2"
        }
      ]
    },
    {
      "CompanyIdentifier": "string 1",
      "CarrierReferenceID": "string 2",
      "Documents": [
        {
          "DocumentType": "LabelZPL",
          "DocumentName": "string 1",
          "DocumentData": "string 2"
        },
        {
          "DocumentType": "LabelZPL",
          "DocumentName": "string 1",
          "DocumentData": "string 2"
        }
      ]
    }
  ],
  "Footer": {
    "TotalRecords": 1,
    "Records": 2
  }
}

application/xml, text/xml

Sample:

<GetShippingDocumentsMessageResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Header>
    <Version>string 1</Version>
    <Identification>string 2</Identification>
    <Sender>string 3</Sender>
  </Header>
  <ShippingDocumentItems>
    <ShippingDocumentItem>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <CarrierReferenceID>string 2</CarrierReferenceID>
      <Documents>
        <DocumentItem>
          <DocumentType>LabelZPL</DocumentType>
          <DocumentName>string 1</DocumentName>
          <DocumentData>string 2</DocumentData>
        </DocumentItem>
        <DocumentItem>
          <DocumentType>LabelZPL</DocumentType>
          <DocumentName>string 1</DocumentName>
          <DocumentData>string 2</DocumentData>
        </DocumentItem>
      </Documents>
    </ShippingDocumentItem>
    <ShippingDocumentItem>
      <CompanyIdentifier>string 1</CompanyIdentifier>
      <CarrierReferenceID>string 2</CarrierReferenceID>
      <Documents>
        <DocumentItem>
          <DocumentType>LabelZPL</DocumentType>
          <DocumentName>string 1</DocumentName>
          <DocumentData>string 2</DocumentData>
        </DocumentItem>
        <DocumentItem>
          <DocumentType>LabelZPL</DocumentType>
          <DocumentName>string 1</DocumentName>
          <DocumentData>string 2</DocumentData>
        </DocumentItem>
      </Documents>
    </ShippingDocumentItem>
  </ShippingDocumentItems>
  <Footer>
    <TotalRecords>1</TotalRecords>
    <Records>2</Records>
  </Footer>
</GetShippingDocumentsMessageResponse>