POST api/ap/shipment?orderID={orderID}

Request Information

URI Parameters

Name	Description	Type	Additional information
orderID		integer	Required

Body Parameters

Shipment

Name	Type	Additional information
ShipmentID	integer	None.
InvoiceNumber	string	Required
DocumentType	ShipmentDocType	Required
DocumentClass	ShipmentDocClass	Required
Comment	string	None.
ShipmentDate	date	Required
DueDate	date	None.
DiscountDate	date	None.
TransactionAmount	decimal number	Required
DiscountAmount	decimal number	None.
HoldAmount	decimal number	None.
Lines	Collection of ShipmentLine	None.
Links	Collection of DocumentLink	None.

Request Formats

application/json, text/json

Sample:

{
  "ShipmentID": 1,
  "InvoiceNumber": "sample string 2",
  "DocumentType": 0,
  "DocumentClass": 0,
  "Comment": "sample string 3",
  "ShipmentDate": "2025-11-01T22:07:16.8427846+13:00",
  "DueDate": "2025-11-01T22:07:16.8427846+13:00",
  "DiscountDate": "2025-11-01T22:07:16.8427846+13:00",
  "TransactionAmount": 5.0,
  "DiscountAmount": 6.0,
  "HoldAmount": 7.0,
  "Lines": [
    {
      "LineType": "sample string 1",
      "Product": {
        "ProductCode": "sample string 1",
        "Description": "sample string 2",
        "AlternateCode": "sample string 3",
        "Barcode": "sample string 4",
        "Barcodes": [
          {
            "Barcode": "sample string 1"
          },
          {
            "Barcode": "sample string 1"
          }
        ],
        "StockGroupCode": "sample string 5",
        "SalesGroupCode": "sample string 6",
        "CreditorCode": "sample string 7",
        "QuantityOnHand": 8.0,
        "NonDiminishing": true,
        "Category2Code": "sample string 10",
        "Unit": "sample string 11"
      },
      "Description": "sample string 2",
      "Unit": "sample string 3",
      "Quantity": 4.0,
      "UnitCost": 5.0,
      "MarkupPercent": 6.0,
      "UnitSell": 7.0,
      "OrderLineID": 1
    },
    {
      "LineType": "sample string 1",
      "Product": {
        "ProductCode": "sample string 1",
        "Description": "sample string 2",
        "AlternateCode": "sample string 3",
        "Barcode": "sample string 4",
        "Barcodes": [
          {
            "Barcode": "sample string 1"
          },
          {
            "Barcode": "sample string 1"
          }
        ],
        "StockGroupCode": "sample string 5",
        "SalesGroupCode": "sample string 6",
        "CreditorCode": "sample string 7",
        "QuantityOnHand": 8.0,
        "NonDiminishing": true,
        "Category2Code": "sample string 10",
        "Unit": "sample string 11"
      },
      "Description": "sample string 2",
      "Unit": "sample string 3",
      "Quantity": 4.0,
      "UnitCost": 5.0,
      "MarkupPercent": 6.0,
      "UnitSell": 7.0,
      "OrderLineID": 1
    }
  ],
  "Links": [
    {
      "FilePath": "sample string 1",
      "ShortName": "sample string 2",
      "LinkID": 3,
      "FileSize": 4,
      "Comment": "sample string 5"
    },
    {
      "FilePath": "sample string 1",
      "ShortName": "sample string 2",
      "LinkID": 3,
      "FileSize": 4,
      "Comment": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:

<Shipment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.AP">
  <Comment>sample string 3</Comment>
  <DiscountAmount>6</DiscountAmount>
  <DiscountDate>2025-11-01T22:07:16.8427846+13:00</DiscountDate>
  <DocumentClass>Shipment</DocumentClass>
  <DocumentType>Invoice</DocumentType>
  <DueDate>2025-11-01T22:07:16.8427846+13:00</DueDate>
  <HoldAmount>7</HoldAmount>
  <InvoiceNumber>sample string 2</InvoiceNumber>
  <Lines>
    <ShipmentLine>
      <Description>sample string 2</Description>
      <LineType>sample string 1</LineType>
      <MarkupPercent>6</MarkupPercent>
      <OrderLineID>1</OrderLineID>
      <Product xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.IC">
        <d4p1:AlternateCode>sample string 3</d4p1:AlternateCode>
        <d4p1:Barcode>sample string 4</d4p1:Barcode>
        <d4p1:Barcodes>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
        </d4p1:Barcodes>
        <d4p1:Category2Code>sample string 10</d4p1:Category2Code>
        <d4p1:CreditorCode>sample string 7</d4p1:CreditorCode>
        <d4p1:Description>sample string 2</d4p1:Description>
        <d4p1:NonDiminishing>true</d4p1:NonDiminishing>
        <d4p1:ProductCode>sample string 1</d4p1:ProductCode>
        <d4p1:QuantityOnHand>8</d4p1:QuantityOnHand>
        <d4p1:SalesGroupCode>sample string 6</d4p1:SalesGroupCode>
        <d4p1:StockGroupCode>sample string 5</d4p1:StockGroupCode>
        <d4p1:Unit>sample string 11</d4p1:Unit>
      </Product>
      <Quantity>4</Quantity>
      <Unit>sample string 3</Unit>
      <UnitCost>5</UnitCost>
      <UnitSell>7</UnitSell>
    </ShipmentLine>
    <ShipmentLine>
      <Description>sample string 2</Description>
      <LineType>sample string 1</LineType>
      <MarkupPercent>6</MarkupPercent>
      <OrderLineID>1</OrderLineID>
      <Product xmlns:d4p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.IC">
        <d4p1:AlternateCode>sample string 3</d4p1:AlternateCode>
        <d4p1:Barcode>sample string 4</d4p1:Barcode>
        <d4p1:Barcodes>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
          <d4p1:ProductBarcode>
            <d4p1:Barcode>sample string 1</d4p1:Barcode>
          </d4p1:ProductBarcode>
        </d4p1:Barcodes>
        <d4p1:Category2Code>sample string 10</d4p1:Category2Code>
        <d4p1:CreditorCode>sample string 7</d4p1:CreditorCode>
        <d4p1:Description>sample string 2</d4p1:Description>
        <d4p1:NonDiminishing>true</d4p1:NonDiminishing>
        <d4p1:ProductCode>sample string 1</d4p1:ProductCode>
        <d4p1:QuantityOnHand>8</d4p1:QuantityOnHand>
        <d4p1:SalesGroupCode>sample string 6</d4p1:SalesGroupCode>
        <d4p1:StockGroupCode>sample string 5</d4p1:StockGroupCode>
        <d4p1:Unit>sample string 11</d4p1:Unit>
      </Product>
      <Quantity>4</Quantity>
      <Unit>sample string 3</Unit>
      <UnitCost>5</UnitCost>
      <UnitSell>7</UnitSell>
    </ShipmentLine>
  </Lines>
  <Links xmlns:d2p1="http://schemas.datacontract.org/2004/07/AccredoWeb.Model.CO">
    <d2p1:DocumentLink>
      <d2p1:Comment>sample string 5</d2p1:Comment>
      <d2p1:FilePath>sample string 1</d2p1:FilePath>
      <d2p1:FileSize>4</d2p1:FileSize>
      <d2p1:LinkID>3</d2p1:LinkID>
      <d2p1:ShortName>sample string 2</d2p1:ShortName>
    </d2p1:DocumentLink>
    <d2p1:DocumentLink>
      <d2p1:Comment>sample string 5</d2p1:Comment>
      <d2p1:FilePath>sample string 1</d2p1:FilePath>
      <d2p1:FileSize>4</d2p1:FileSize>
      <d2p1:LinkID>3</d2p1:LinkID>
      <d2p1:ShortName>sample string 2</d2p1:ShortName>
    </d2p1:DocumentLink>
  </Links>
  <ShipmentDate>2025-11-01T22:07:16.8427846+13:00</ShipmentDate>
  <ShipmentID>1</ShipmentID>
  <TransactionAmount>5</TransactionAmount>
</Shipment>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>