POST api/Parcel
Request Information
URI Parameters
None.
Body Parameters
PackageEntity| Name | Description | Type | Additional information |
|---|---|---|---|
| System_ID | globally unique identifier |
None. |
|
| Service_GUID | string |
None. |
|
| Tracking_ID | string |
None. |
|
| Package_ID | string |
None. |
|
| Length | string |
None. |
|
| Height | string |
None. |
|
| Width | string |
None. |
|
| LWH_Unit | string |
None. |
|
| Weight | string |
None. |
|
| Weight_Unit | string |
None. |
|
| TrackingImage_location | string |
None. |
|
| PIDImage_Location | string |
None. |
|
| DimensioningImage_location | string |
None. |
|
| MainImage_location | string |
None. |
|
| ChildImage1_location | string |
None. |
|
| ChildImage2_location | string |
None. |
|
| ChildImage3_location | string |
None. |
|
| Status_ID | integer |
None. |
|
| DimensionerStatus | string |
None. |
|
| Dimensions_Barcode_Caption | string |
None. |
|
| Dimensions_Barcode_No | string |
None. |
|
| PrintLabel_Count | integer |
None. |
|
| User_id | integer |
None. |
|
| Mapping_ID | integer |
None. |
|
| UserName | string |
None. |
|
| ChildImage4_location | string |
None. |
|
| DeviceType | string |
None. |
|
| CapturedTime | string |
None. |
|
| CapturedDate | date |
None. |
|
| Created_DateTime | date |
None. |
|
| TotalRecords | integer |
None. |
|
| StatusCode | integer |
None. |
|
| ErrorMessage | string |
None. |
|
| IsDimensionsLoaded | boolean |
None. |
|
| CaptureMode | integer |
None. |
|
| IsRecordFetchByPID | boolean |
None. |
|
| Dimensioner_ID | integer |
None. |
|
| TrackingOrPackageID | string |
None. |
|
| ChildImage1_Content | string |
None. |
|
| ChildImage2_Content | string |
None. |
|
| ChildImage3_Content | string |
None. |
|
| ChildImage4_Content | string |
None. |
|
| Protocol | string |
None. |
|
| IsPro | boolean |
None. |
|
| PrintTrackerOrGenerateID | boolean |
None. |
|
| PrintDimensionsandWeight | boolean |
None. |
|
| PrintLableAutomationID | integer |
None. |
|
| PrintOrientation | string |
None. |
|
| PrintQuantity | integer |
None. |
|
| DownloadType | integer |
None. |
|
| CapturedDateString | string |
None. |
|
| Naming_Convetion | integer |
None. |
|
| Custom_Name | string |
None. |
|
| Note | string |
None. |
|
| CompanyID | integer |
None. |
|
| CompanyName | string |
None. |
|
| PreviousCaptureID | string |
None. |
|
| BatchId | integer |
None. |
|
| Scanned | integer |
None. |
|
| ToBeScanned | integer |
None. |
|
| BatchPackageSequence | integer |
None. |
|
| IsDeleted | boolean |
None. |
|
| IsUpdateWithoutCapture | boolean |
None. |
|
| Modified_DateTime | date |
None. |
|
| Modified_User_ID | integer |
None. |
|
| Dimensions_Barcode_No_1 | string |
None. |
|
| Dimensions_Barcode_Caption_1 | string |
None. |
|
| DimensioningImage_location_1 | string |
None. |
|
| SkipBatchUpdate | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"System_ID": "37ec1c09-6b5d-45dd-b81a-1fa8a490802d",
"Service_GUID": "sample string 2",
"Tracking_ID": "sample string 3",
"Package_ID": "sample string 4",
"Length": "sample string 5",
"Height": "sample string 6",
"Width": "sample string 7",
"LWH_Unit": "sample string 8",
"Weight": "sample string 9",
"Weight_Unit": "sample string 10",
"TrackingImage_location": "sample string 11",
"PIDImage_Location": "sample string 12",
"DimensioningImage_location": "sample string 13",
"MainImage_location": "sample string 14",
"ChildImage1_location": "sample string 15",
"ChildImage2_location": "sample string 16",
"ChildImage3_location": "sample string 17",
"Status_ID": 1,
"DimensionerStatus": "sample string 18",
"Dimensions_Barcode_Caption": "sample string 19",
"Dimensions_Barcode_No": "sample string 20",
"PrintLabel_Count": 1,
"User_id": 1,
"Mapping_ID": 1,
"UserName": "sample string 21",
"ChildImage4_location": "sample string 22",
"DeviceType": "sample string 23",
"CapturedTime": "sample string 24",
"CapturedDate": "2026-02-04T20:49:34.287297-05:00",
"Created_DateTime": "2026-02-04T20:49:34.287297-05:00",
"TotalRecords": 26,
"StatusCode": 27,
"ErrorMessage": "sample string 28",
"IsDimensionsLoaded": true,
"CaptureMode": 30,
"IsRecordFetchByPID": true,
"Dimensioner_ID": 32,
"TrackingOrPackageID": "sample string 33",
"ChildImage1_Content": "sample string 34",
"ChildImage2_Content": "sample string 35",
"ChildImage3_Content": "sample string 36",
"ChildImage4_Content": "sample string 37",
"Protocol": "sample string 38",
"IsPro": true,
"PrintTrackerOrGenerateID": true,
"PrintDimensionsandWeight": true,
"PrintLableAutomationID": 1,
"PrintOrientation": "sample string 40",
"PrintQuantity": 1,
"DownloadType": 41,
"CapturedDateString": "sample string 42",
"Naming_Convetion": 1,
"Custom_Name": "sample string 43",
"Note": "sample string 44",
"CompanyID": 1,
"CompanyName": "sample string 45",
"PreviousCaptureID": "sample string 46",
"BatchId": 1,
"Scanned": 1,
"ToBeScanned": 1,
"BatchPackageSequence": 1,
"IsDeleted": true,
"IsUpdateWithoutCapture": true,
"Modified_DateTime": "2026-02-04T20:49:34.287297-05:00",
"Modified_User_ID": 1,
"Dimensions_Barcode_No_1": "sample string 48",
"Dimensions_Barcode_Caption_1": "sample string 49",
"DimensioningImage_location_1": "sample string 50",
"SkipBatchUpdate": true
}
application/xml, text/xml
Sample:
<PackageEntity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyzerg.Model"> <BatchId>1</BatchId> <BatchPackageSequence>1</BatchPackageSequence> <CaptureMode>30</CaptureMode> <CapturedDate>2026-02-04T20:49:34.287297-05:00</CapturedDate> <CapturedDateString>sample string 42</CapturedDateString> <CapturedTime>sample string 24</CapturedTime> <ChildImage1_Content>sample string 34</ChildImage1_Content> <ChildImage1_location>sample string 15</ChildImage1_location> <ChildImage2_Content>sample string 35</ChildImage2_Content> <ChildImage2_location>sample string 16</ChildImage2_location> <ChildImage3_Content>sample string 36</ChildImage3_Content> <ChildImage3_location>sample string 17</ChildImage3_location> <ChildImage4_Content>sample string 37</ChildImage4_Content> <ChildImage4_location>sample string 22</ChildImage4_location> <CompanyID>1</CompanyID> <CompanyName>sample string 45</CompanyName> <Created_DateTime>2026-02-04T20:49:34.287297-05:00</Created_DateTime> <Custom_Name>sample string 43</Custom_Name> <DeviceType>sample string 23</DeviceType> <DimensionerStatus>sample string 18</DimensionerStatus> <Dimensioner_ID>32</Dimensioner_ID> <DimensioningImage_location>sample string 13</DimensioningImage_location> <DimensioningImage_location_1>sample string 50</DimensioningImage_location_1> <Dimensions_Barcode_Caption>sample string 19</Dimensions_Barcode_Caption> <Dimensions_Barcode_Caption_1>sample string 49</Dimensions_Barcode_Caption_1> <Dimensions_Barcode_No>sample string 20</Dimensions_Barcode_No> <Dimensions_Barcode_No_1>sample string 48</Dimensions_Barcode_No_1> <DownloadType>41</DownloadType> <ErrorMessage>sample string 28</ErrorMessage> <Height>sample string 6</Height> <IsDeleted>true</IsDeleted> <IsDimensionsLoaded>true</IsDimensionsLoaded> <IsPro>true</IsPro> <IsRecordFetchByPID>true</IsRecordFetchByPID> <IsUpdateWithoutCapture>true</IsUpdateWithoutCapture> <LWH_Unit>sample string 8</LWH_Unit> <Length>sample string 5</Length> <MainImage_location>sample string 14</MainImage_location> <Mapping_ID>1</Mapping_ID> <Modified_DateTime>2026-02-04T20:49:34.287297-05:00</Modified_DateTime> <Modified_User_ID>1</Modified_User_ID> <Naming_Convetion>1</Naming_Convetion> <Note>sample string 44</Note> <PIDImage_Location>sample string 12</PIDImage_Location> <Package_ID>sample string 4</Package_ID> <PreviousCaptureID>sample string 46</PreviousCaptureID> <PrintDimensionsandWeight>true</PrintDimensionsandWeight> <PrintLabel_Count>1</PrintLabel_Count> <PrintLableAutomationID>1</PrintLableAutomationID> <PrintOrientation>sample string 40</PrintOrientation> <PrintQuantity>1</PrintQuantity> <PrintTrackerOrGenerateID>true</PrintTrackerOrGenerateID> <Protocol>sample string 38</Protocol> <Scanned>1</Scanned> <Service_GUID>sample string 2</Service_GUID> <SkipBatchUpdate>true</SkipBatchUpdate> <StatusCode>27</StatusCode> <Status_ID>1</Status_ID> <System_ID>37ec1c09-6b5d-45dd-b81a-1fa8a490802d</System_ID> <ToBeScanned>1</ToBeScanned> <TotalRecords>26</TotalRecords> <TrackingImage_location>sample string 11</TrackingImage_location> <TrackingOrPackageID>sample string 33</TrackingOrPackageID> <Tracking_ID>sample string 3</Tracking_ID> <UserName>sample string 21</UserName> <User_id>1</User_id> <Weight>sample string 9</Weight> <Weight_Unit>sample string 10</Weight_Unit> <Width>sample string 7</Width> </PackageEntity>
application/x-www-form-urlencoded
Sample:
Sample not available.
text/html
Sample:
{"System_ID":"37ec1c09-6b5d-45dd-b81a-1fa8a490802d","Service_GUID":"sample string 2","Tracking_ID":"sample string 3","Package_ID":"sample string 4","Length":"sample string 5","Height":"sample string 6","Width":"sample string 7","LWH_Unit":"sample string 8","Weight":"sample string 9","Weight_Unit":"sample string 10","TrackingImage_location":"sample string 11","PIDImage_Location":"sample string 12","DimensioningImage_location":"sample string 13","MainImage_location":"sample string 14","ChildImage1_location":"sample string 15","ChildImage2_location":"sample string 16","ChildImage3_location":"sample string 17","Status_ID":1,"DimensionerStatus":"sample string 18","Dimensions_Barcode_Caption":"sample string 19","Dimensions_Barcode_No":"sample string 20","PrintLabel_Count":1,"User_id":1,"Mapping_ID":1,"UserName":"sample string 21","ChildImage4_location":"sample string 22","DeviceType":"sample string 23","CapturedTime":"sample string 24","CapturedDate":"2026-02-04T20:49:34.287297-05:00","Created_DateTime":"2026-02-04T20:49:34.287297-05:00","TotalRecords":26,"StatusCode":27,"ErrorMessage":"sample string 28","IsDimensionsLoaded":true,"CaptureMode":30,"IsRecordFetchByPID":true,"Dimensioner_ID":32,"TrackingOrPackageID":"sample string 33","ChildImage1_Content":"sample string 34","ChildImage2_Content":"sample string 35","ChildImage3_Content":"sample string 36","ChildImage4_Content":"sample string 37","Protocol":"sample string 38","IsPro":true,"PrintTrackerOrGenerateID":true,"PrintDimensionsandWeight":true,"PrintLableAutomationID":1,"PrintOrientation":"sample string 40","PrintQuantity":1,"DownloadType":41,"CapturedDateString":"sample string 42","Naming_Convetion":1,"Custom_Name":"sample string 43","Note":"sample string 44","CompanyID":1,"CompanyName":"sample string 45","PreviousCaptureID":"sample string 46","BatchId":1,"Scanned":1,"ToBeScanned":1,"BatchPackageSequence":1,"IsDeleted":true,"IsUpdateWithoutCapture":true,"Modified_DateTime":"2026-02-04T20:49:34.287297-05:00","Modified_User_ID":1,"Dimensions_Barcode_No_1":"sample string 48","Dimensions_Barcode_Caption_1":"sample string 49","DimensioningImage_location_1":"sample string 50","SkipBatchUpdate":true}
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |