POST api/v1/{posId}/shipments

Request Information

URI Parameters

Name	Description	Type	Additional information
posId		string	None.

Body Parameters

SalesShipmentHeader

Name	Type	Additional information
Key	string	None.
AgreementNo	string	None.
ContactNo	string	None.
CustomerAddress	string	None.
CustomerAddress2	string	None.
CustomerCity	string	None.
CustomerName	string	None.
CustomerNo	string	None.
CustomerPostNo	string	None.
DeliveryAddressCode	string	None.
IsInvoiced	boolean	None.
No	string	None.
OrderDate	date	None.
SalesOrderPosID	string	None.
OrderNo	string	None.
PostingDate	date	None.
PostingTime	string	None.
ReferenceName	string	None.
ReferenceNo	string	None.
SalesPerson	string	None.
StoreID	string	None.
DeliveryCode	string	None.
DeliveryDate	date	None.
DeliveryTime	string	None.
TrackingNo	string	None.
IsSynchronized	boolean	None.
InvoiceCustomerNo	string	None.
IsSyncedToMaster	boolean	None.
SignatureImage	string	None.
VisionSyncTimestamp	date	None.
Lines	Collection of SalesShipmentLine	None.
ItemTransits	Collection of ItemTransit	None.

Request Formats

application/json, text/json

Sample:

{
  "Key": "sample string 10",
  "AgreementNo": "sample string 1",
  "ContactNo": "sample string 2",
  "CustomerAddress": "sample string 3",
  "CustomerAddress2": "sample string 4",
  "CustomerCity": "sample string 5",
  "CustomerName": "sample string 6",
  "CustomerNo": "sample string 7",
  "CustomerPostNo": "sample string 8",
  "DeliveryAddressCode": "sample string 9",
  "IsInvoiced": true,
  "No": "sample string 10",
  "OrderDate": "2025-12-06T05:41:28.6380323+01:00",
  "SalesOrderPosID": "sample string 12",
  "OrderNo": "sample string 13",
  "PostingDate": "2025-12-06T05:41:28.6380323+01:00",
  "PostingTime": "sample string 15",
  "ReferenceName": "sample string 16",
  "ReferenceNo": "sample string 17",
  "SalesPerson": "sample string 18",
  "StoreID": "sample string 19",
  "DeliveryCode": "sample string 20",
  "DeliveryDate": "2025-12-06T05:41:28.6380323+01:00",
  "DeliveryTime": "sample string 21",
  "TrackingNo": "sample string 22",
  "IsSynchronized": true,
  "InvoiceCustomerNo": "sample string 23",
  "IsSyncedToMaster": true,
  "SignatureImage": "sample string 24",
  "VisionSyncTimestamp": "2025-12-06T05:41:28.6380323+01:00",
  "Lines": [
    {
      "Amount": 1.0,
      "AmountInclVAT": 1.0,
      "CampaignCode": "sample string 2",
      "CashRegSettlementNo": "sample string 3",
      "Description": "sample string 4",
      "DiscountAmount": 1.0,
      "DiscountPercent": 1.0,
      "LineNo": 5,
      "No": "sample string 6",
      "Quantity": 7.0,
      "SerialNo": "sample string 8",
      "SerialNo2": "sample string 9",
      "ServiceNo": "sample string 10",
      "ShipmentNo": "sample string 11",
      "StoreID": "sample string 12",
      "TransactionNo": "sample string 13",
      "Type": 14,
      "UnitCost": 1.0,
      "UnitPrice": 1.0,
      "VATPercent": 1.0,
      "VariantCode": "sample string 15",
      "Comment": "sample string 16",
      "SortOrder": 1,
      "UnitCode": "sample string 17",
      "TimeSheetId": 1,
      "SalesPersonNo": "sample string 18",
      "FixedPriceLineNo": 1,
      "CalculatedPrice": 1.0,
      "Specifications": [
        {
          "Amount": 1.0,
          "Code": "sample string 1",
          "CommissionAgreementNo": "sample string 2",
          "CustomerAmount": 1.0,
          "Description": "sample string 3",
          "LineNo": 4,
          "PhoneNo": "sample string 5",
          "SalesShipmentHeaderNo": "sample string 6",
          "SalesShipmentLineNo": 7,
          "StoreID": "sample string 8",
          "Type": 1,
          "SerialNo": "sample string 9",
          "SerialNo2": "sample string 10"
        },
        {
          "Amount": 1.0,
          "Code": "sample string 1",
          "CommissionAgreementNo": "sample string 2",
          "CustomerAmount": 1.0,
          "Description": "sample string 3",
          "LineNo": 4,
          "PhoneNo": "sample string 5",
          "SalesShipmentHeaderNo": "sample string 6",
          "SalesShipmentLineNo": 7,
          "StoreID": "sample string 8",
          "Type": 1,
          "SerialNo": "sample string 9",
          "SerialNo2": "sample string 10"
        }
      ]
    },
    {
      "Amount": 1.0,
      "AmountInclVAT": 1.0,
      "CampaignCode": "sample string 2",
      "CashRegSettlementNo": "sample string 3",
      "Description": "sample string 4",
      "DiscountAmount": 1.0,
      "DiscountPercent": 1.0,
      "LineNo": 5,
      "No": "sample string 6",
      "Quantity": 7.0,
      "SerialNo": "sample string 8",
      "SerialNo2": "sample string 9",
      "ServiceNo": "sample string 10",
      "ShipmentNo": "sample string 11",
      "StoreID": "sample string 12",
      "TransactionNo": "sample string 13",
      "Type": 14,
      "UnitCost": 1.0,
      "UnitPrice": 1.0,
      "VATPercent": 1.0,
      "VariantCode": "sample string 15",
      "Comment": "sample string 16",
      "SortOrder": 1,
      "UnitCode": "sample string 17",
      "TimeSheetId": 1,
      "SalesPersonNo": "sample string 18",
      "FixedPriceLineNo": 1,
      "CalculatedPrice": 1.0,
      "Specifications": [
        {
          "Amount": 1.0,
          "Code": "sample string 1",
          "CommissionAgreementNo": "sample string 2",
          "CustomerAmount": 1.0,
          "Description": "sample string 3",
          "LineNo": 4,
          "PhoneNo": "sample string 5",
          "SalesShipmentHeaderNo": "sample string 6",
          "SalesShipmentLineNo": 7,
          "StoreID": "sample string 8",
          "Type": 1,
          "SerialNo": "sample string 9",
          "SerialNo2": "sample string 10"
        },
        {
          "Amount": 1.0,
          "Code": "sample string 1",
          "CommissionAgreementNo": "sample string 2",
          "CustomerAmount": 1.0,
          "Description": "sample string 3",
          "LineNo": 4,
          "PhoneNo": "sample string 5",
          "SalesShipmentHeaderNo": "sample string 6",
          "SalesShipmentLineNo": 7,
          "StoreID": "sample string 8",
          "Type": 1,
          "SerialNo": "sample string 9",
          "SerialNo2": "sample string 10"
        }
      ]
    }
  ],
  "ItemTransits": [
    {
      "StoreID": "sample string 1",
      "DocumentNo": "sample string 2",
      "LineNo": 3,
      "Date": "2025-12-06T05:41:28.6380323+01:00",
      "Type": "sample string 4",
      "ItemNo": "sample string 5",
      "Quantity": 6.0,
      "POS": "sample string 7",
      "VariantCode": "sample string 8"
    },
    {
      "StoreID": "sample string 1",
      "DocumentNo": "sample string 2",
      "LineNo": 3,
      "Date": "2025-12-06T05:41:28.6380323+01:00",
      "Type": "sample string 4",
      "ItemNo": "sample string 5",
      "Quantity": 6.0,
      "POS": "sample string 7",
      "VariantCode": "sample string 8"
    }
  ]
}

text/html

Sample:

{"Key":"sample string 10","AgreementNo":"sample string 1","ContactNo":"sample string 2","CustomerAddress":"sample string 3","CustomerAddress2":"sample string 4","CustomerCity":"sample string 5","CustomerName":"sample string 6","CustomerNo":"sample string 7","CustomerPostNo":"sample string 8","DeliveryAddressCode":"sample string 9","IsInvoiced":true,"No":"sample string 10","OrderDate":"2025-12-06T05:41:28.6380323+01:00","SalesOrderPosID":"sample string 12","OrderNo":"sample string 13","PostingDate":"2025-12-06T05:41:28.6380323+01:00","PostingTime":"sample string 15","ReferenceName":"sample string 16","ReferenceNo":"sample string 17","SalesPerson":"sample string 18","StoreID":"sample string 19","DeliveryCode":"sample string 20","DeliveryDate":"2025-12-06T05:41:28.6380323+01:00","DeliveryTime":"sample string 21","TrackingNo":"sample string 22","IsSynchronized":true,"InvoiceCustomerNo":"sample string 23","IsSyncedToMaster":true,"SignatureImage":"sample string 24","VisionSyncTimestamp":"2025-12-06T05:41:28.6380323+01:00","Lines":[{"Amount":1.0,"AmountInclVAT":1.0,"CampaignCode":"sample string 2","CashRegSettlementNo":"sample string 3","Description":"sample string 4","DiscountAmount":1.0,"DiscountPercent":1.0,"LineNo":5,"No":"sample string 6","Quantity":7.0,"SerialNo":"sample string 8","SerialNo2":"sample string 9","ServiceNo":"sample string 10","ShipmentNo":"sample string 11","StoreID":"sample string 12","TransactionNo":"sample string 13","Type":14,"UnitCost":1.0,"UnitPrice":1.0,"VATPercent":1.0,"VariantCode":"sample string 15","Comment":"sample string 16","SortOrder":1,"UnitCode":"sample string 17","TimeSheetId":1,"SalesPersonNo":"sample string 18","FixedPriceLineNo":1,"CalculatedPrice":1.0,"Specifications":[{"Amount":1.0,"Code":"sample string 1","CommissionAgreementNo":"sample string 2","CustomerAmount":1.0,"Description":"sample string 3","LineNo":4,"PhoneNo":"sample string 5","SalesShipmentHeaderNo":"sample string 6","SalesShipmentLineNo":7,"StoreID":"sample string 8","Type":1,"SerialNo":"sample string 9","SerialNo2":"sample string 10"},{"Amount":1.0,"Code":"sample string 1","CommissionAgreementNo":"sample string 2","CustomerAmount":1.0,"Description":"sample string 3","LineNo":4,"PhoneNo":"sample string 5","SalesShipmentHeaderNo":"sample string 6","SalesShipmentLineNo":7,"StoreID":"sample string 8","Type":1,"SerialNo":"sample string 9","SerialNo2":"sample string 10"}]},{"Amount":1.0,"AmountInclVAT":1.0,"CampaignCode":"sample string 2","CashRegSettlementNo":"sample string 3","Description":"sample string 4","DiscountAmount":1.0,"DiscountPercent":1.0,"LineNo":5,"No":"sample string 6","Quantity":7.0,"SerialNo":"sample string 8","SerialNo2":"sample string 9","ServiceNo":"sample string 10","ShipmentNo":"sample string 11","StoreID":"sample string 12","TransactionNo":"sample string 13","Type":14,"UnitCost":1.0,"UnitPrice":1.0,"VATPercent":1.0,"VariantCode":"sample string 15","Comment":"sample string 16","SortOrder":1,"UnitCode":"sample string 17","TimeSheetId":1,"SalesPersonNo":"sample string 18","FixedPriceLineNo":1,"CalculatedPrice":1.0,"Specifications":[{"Amount":1.0,"Code":"sample string 1","CommissionAgreementNo":"sample string 2","CustomerAmount":1.0,"Description":"sample string 3","LineNo":4,"PhoneNo":"sample string 5","SalesShipmentHeaderNo":"sample string 6","SalesShipmentLineNo":7,"StoreID":"sample string 8","Type":1,"SerialNo":"sample string 9","SerialNo2":"sample string 10"},{"Amount":1.0,"Code":"sample string 1","CommissionAgreementNo":"sample string 2","CustomerAmount":1.0,"Description":"sample string 3","LineNo":4,"PhoneNo":"sample string 5","SalesShipmentHeaderNo":"sample string 6","SalesShipmentLineNo":7,"StoreID":"sample string 8","Type":1,"SerialNo":"sample string 9","SerialNo2":"sample string 10"}]}],"ItemTransits":[{"StoreID":"sample string 1","DocumentNo":"sample string 2","LineNo":3,"Date":"2025-12-06T05:41:28.6380323+01:00","Type":"sample string 4","ItemNo":"sample string 5","Quantity":6.0,"POS":"sample string 7","VariantCode":"sample string 8"},{"StoreID":"sample string 1","DocumentNo":"sample string 2","LineNo":3,"Date":"2025-12-06T05:41:28.6380323+01:00","Type":"sample string 4","ItemNo":"sample string 5","Quantity":6.0,"POS":"sample string 7","VariantCode":"sample string 8"}]}

application/x-www-form-urlencoded

Sample:

Sample not available.

application/xml, text/xml

Sample:

<Root>
  <Data>
    <Key>sample string 10</Key>
    <AgreementNo>sample string 1</AgreementNo>
    <ContactNo>sample string 2</ContactNo>
    <CustomerAddress>sample string 3</CustomerAddress>
    <CustomerAddress2>sample string 4</CustomerAddress2>
    <CustomerCity>sample string 5</CustomerCity>
    <CustomerName>sample string 6</CustomerName>
    <CustomerNo>sample string 7</CustomerNo>
    <CustomerPostNo>sample string 8</CustomerPostNo>
    <DeliveryAddressCode>sample string 9</DeliveryAddressCode>
    <IsInvoiced>true</IsInvoiced>
    <No>sample string 10</No>
    <OrderDate>2025-12-06T05:41:28.6380323+01:00</OrderDate>
    <SalesOrderPosID>sample string 12</SalesOrderPosID>
    <OrderNo>sample string 13</OrderNo>
    <PostingDate>2025-12-06T05:41:28.6380323+01:00</PostingDate>
    <PostingTime>sample string 15</PostingTime>
    <ReferenceName>sample string 16</ReferenceName>
    <ReferenceNo>sample string 17</ReferenceNo>
    <SalesPerson>sample string 18</SalesPerson>
    <StoreID>sample string 19</StoreID>
    <DeliveryCode>sample string 20</DeliveryCode>
    <DeliveryDate>2025-12-06T05:41:28.6380323+01:00</DeliveryDate>
    <DeliveryTime>sample string 21</DeliveryTime>
    <TrackingNo>sample string 22</TrackingNo>
    <IsSynchronized>true</IsSynchronized>
    <InvoiceCustomerNo>sample string 23</InvoiceCustomerNo>
    <IsSyncedToMaster>true</IsSyncedToMaster>
    <SignatureImage>sample string 24</SignatureImage>
    <VisionSyncTimestamp>2025-12-06T05:41:28.6380323+01:00</VisionSyncTimestamp>
    <Lines>
      <Amount>1</Amount>
      <AmountInclVAT>1</AmountInclVAT>
      <CampaignCode>sample string 2</CampaignCode>
      <CashRegSettlementNo>sample string 3</CashRegSettlementNo>
      <Description>sample string 4</Description>
      <DiscountAmount>1</DiscountAmount>
      <DiscountPercent>1</DiscountPercent>
      <LineNo>5</LineNo>
      <No>sample string 6</No>
      <Quantity>7</Quantity>
      <SerialNo>sample string 8</SerialNo>
      <SerialNo2>sample string 9</SerialNo2>
      <ServiceNo>sample string 10</ServiceNo>
      <ShipmentNo>sample string 11</ShipmentNo>
      <StoreID>sample string 12</StoreID>
      <TransactionNo>sample string 13</TransactionNo>
      <Type>14</Type>
      <UnitCost>1</UnitCost>
      <UnitPrice>1</UnitPrice>
      <VATPercent>1</VATPercent>
      <VariantCode>sample string 15</VariantCode>
      <Comment>sample string 16</Comment>
      <SortOrder>1</SortOrder>
      <UnitCode>sample string 17</UnitCode>
      <TimeSheetId>1</TimeSheetId>
      <SalesPersonNo>sample string 18</SalesPersonNo>
      <FixedPriceLineNo>1</FixedPriceLineNo>
      <CalculatedPrice>1</CalculatedPrice>
      <Specifications>
        <Amount>1</Amount>
        <Code>sample string 1</Code>
        <CommissionAgreementNo>sample string 2</CommissionAgreementNo>
        <CustomerAmount>1</CustomerAmount>
        <Description>sample string 3</Description>
        <LineNo>4</LineNo>
        <PhoneNo>sample string 5</PhoneNo>
        <SalesShipmentHeaderNo>sample string 6</SalesShipmentHeaderNo>
        <SalesShipmentLineNo>7</SalesShipmentLineNo>
        <StoreID>sample string 8</StoreID>
        <Type>1</Type>
        <SerialNo>sample string 9</SerialNo>
        <SerialNo2>sample string 10</SerialNo2>
      </Specifications>
      <Specifications>
        <Amount>1</Amount>
        <Code>sample string 1</Code>
        <CommissionAgreementNo>sample string 2</CommissionAgreementNo>
        <CustomerAmount>1</CustomerAmount>
        <Description>sample string 3</Description>
        <LineNo>4</LineNo>
        <PhoneNo>sample string 5</PhoneNo>
        <SalesShipmentHeaderNo>sample string 6</SalesShipmentHeaderNo>
        <SalesShipmentLineNo>7</SalesShipmentLineNo>
        <StoreID>sample string 8</StoreID>
        <Type>1</Type>
        <SerialNo>sample string 9</SerialNo>
        <SerialNo2>sample string 10</SerialNo2>
      </Specifications>
    </Lines>
    <Lines>
      <Amount>1</Amount>
      <AmountInclVAT>1</AmountInclVAT>
      <CampaignCode>sample string 2</CampaignCode>
      <CashRegSettlementNo>sample string 3</CashRegSettlementNo>
      <Description>sample string 4</Description>
      <DiscountAmount>1</DiscountAmount>
      <DiscountPercent>1</DiscountPercent>
      <LineNo>5</LineNo>
      <No>sample string 6</No>
      <Quantity>7</Quantity>
      <SerialNo>sample string 8</SerialNo>
      <SerialNo2>sample string 9</SerialNo2>
      <ServiceNo>sample string 10</ServiceNo>
      <ShipmentNo>sample string 11</ShipmentNo>
      <StoreID>sample string 12</StoreID>
      <TransactionNo>sample string 13</TransactionNo>
      <Type>14</Type>
      <UnitCost>1</UnitCost>
      <UnitPrice>1</UnitPrice>
      <VATPercent>1</VATPercent>
      <VariantCode>sample string 15</VariantCode>
      <Comment>sample string 16</Comment>
      <SortOrder>1</SortOrder>
      <UnitCode>sample string 17</UnitCode>
      <TimeSheetId>1</TimeSheetId>
      <SalesPersonNo>sample string 18</SalesPersonNo>
      <FixedPriceLineNo>1</FixedPriceLineNo>
      <CalculatedPrice>1</CalculatedPrice>
      <Specifications>
        <Amount>1</Amount>
        <Code>sample string 1</Code>
        <CommissionAgreementNo>sample string 2</CommissionAgreementNo>
        <CustomerAmount>1</CustomerAmount>
        <Description>sample string 3</Description>
        <LineNo>4</LineNo>
        <PhoneNo>sample string 5</PhoneNo>
        <SalesShipmentHeaderNo>sample string 6</SalesShipmentHeaderNo>
        <SalesShipmentLineNo>7</SalesShipmentLineNo>
        <StoreID>sample string 8</StoreID>
        <Type>1</Type>
        <SerialNo>sample string 9</SerialNo>
        <SerialNo2>sample string 10</SerialNo2>
      </Specifications>
      <Specifications>
        <Amount>1</Amount>
        <Code>sample string 1</Code>
        <CommissionAgreementNo>sample string 2</CommissionAgreementNo>
        <CustomerAmount>1</CustomerAmount>
        <Description>sample string 3</Description>
        <LineNo>4</LineNo>
        <PhoneNo>sample string 5</PhoneNo>
        <SalesShipmentHeaderNo>sample string 6</SalesShipmentHeaderNo>
        <SalesShipmentLineNo>7</SalesShipmentLineNo>
        <StoreID>sample string 8</StoreID>
        <Type>1</Type>
        <SerialNo>sample string 9</SerialNo>
        <SerialNo2>sample string 10</SerialNo2>
      </Specifications>
    </Lines>
    <ItemTransits>
      <StoreID>sample string 1</StoreID>
      <DocumentNo>sample string 2</DocumentNo>
      <LineNo>3</LineNo>
      <Date>2025-12-06T05:41:28.6380323+01:00</Date>
      <Type>sample string 4</Type>
      <ItemNo>sample string 5</ItemNo>
      <Quantity>6</Quantity>
      <POS>sample string 7</POS>
      <VariantCode>sample string 8</VariantCode>
    </ItemTransits>
    <ItemTransits>
      <StoreID>sample string 1</StoreID>
      <DocumentNo>sample string 2</DocumentNo>
      <LineNo>3</LineNo>
      <Date>2025-12-06T05:41:28.6380323+01:00</Date>
      <Type>sample string 4</Type>
      <ItemNo>sample string 5</ItemNo>
      <Quantity>6</Quantity>
      <POS>sample string 7</POS>
      <VariantCode>sample string 8</VariantCode>
    </ItemTransits>
  </Data>
</Root>

application/csv

Sample:

Sample not available.

text/csv

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json, text/html

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<Root>
  <Data>sample string 1</Data>
</Root>

application/csv

Sample:

Sample not available.

text/csv

Sample:

Sample not available.