POST api/Shipment/CreateShipment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
businessId	integer	None.
userId	integer	None.
warehouseMasterId	integer	None.
isSSD	integer	None.
noOfOrder	integer	None.
totalItem	integer	None.
totalQty	decimal number	None.
totalAmount	decimal number	None.
latitudeQuality	string	None.
longitudeQuality	string	None.
orderIds	Collection of integer	None.
IsManufacturerShipment	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "businessId": 1,
  "userId": 2,
  "warehouseMasterId": 3,
  "isSSD": 4,
  "noOfOrder": 5,
  "totalItem": 6,
  "totalQty": 7.0,
  "totalAmount": 8.0,
  "latitudeQuality": "sample string 9",
  "longitudeQuality": "sample string 10",
  "orderIds": [
    1,
    2
  ],
  "IsManufacturerShipment": 11
}

text/html

Sample:

{"businessId":1,"userId":2,"warehouseMasterId":3,"isSSD":4,"noOfOrder":5,"totalItem":6,"totalQty":7.0,"totalAmount":8.0,"latitudeQuality":"sample string 9","longitudeQuality":"sample string 10","orderIds":[1,2],"IsManufacturerShipment":11}

application/xml, text/xml

Sample:

<CreateShipmentPrm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
  <IsManufacturerShipment>11</IsManufacturerShipment>
  <businessId>1</businessId>
  <isSSD>4</isSSD>
  <latitudeQuality>sample string 9</latitudeQuality>
  <longitudeQuality>sample string 10</longitudeQuality>
  <noOfOrder>5</noOfOrder>
  <orderIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </orderIds>
  <totalAmount>8</totalAmount>
  <totalItem>6</totalItem>
  <totalQty>7</totalQty>
  <userId>2</userId>
  <warehouseMasterId>3</warehouseMasterId>
</CreateShipmentPrm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VCAPIResponse

Name	Type	Additional information
Version	string	None.
dateTime	string	None.
StatusCode	integer	None.
ErrorMessage	string	None.
Result	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Version": "1.0.0",
  "dateTime": "2025/12/28 05:09:24",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

text/html

Sample:

{"Version":"1.0.0","dateTime":"2025/12/28 05:09:24","StatusCode":1,"ErrorMessage":"sample string 2","Result":{}}

application/xml, text/xml

Sample:

<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>