POST v1/Order/EntireOrderGet
Request Information
URI Parameters
None.
Body Parameters
EntireOrderGetRequestName | Description | Type | Additional information |
---|---|---|---|
OrderNumber | string |
Required |
|
IncludeServices | boolean |
None. |
|
IncludeDrop | boolean |
None. |
|
IncludeInventory | boolean |
None. |
|
IncludePostage | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "OrderNumber": "sample string 1", "IncludeServices": true, "IncludeDrop": true, "IncludeInventory": true, "IncludePostage": true }
application/xml, text/xml
Sample:
<EntireOrderGetRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <OrderNumber>sample string 1</OrderNumber> <IncludeServices>true</IncludeServices> <IncludeDrop>true</IncludeDrop> <IncludeInventory>true</IncludeInventory> <IncludePostage>true</IncludePostage> </EntireOrderGetRequest>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
EntireOrderGetResponseName | Description | Type | Additional information |
---|---|---|---|
OrderVersionList | Collection of EntireOrderVersion |
None. |
|
OrderID | integer |
None. |
|
OrderNumber | string |
None. |
|
CustomerID | integer |
None. |
|
CustomerName | string |
None. |
|
ContactName | string |
None. |
|
SalesRepName | string |
None. |
|
CSRName | string |
None. |
|
ProjectName | string |
None. |
|
LicenseeName | string |
None. |
|
PurchaseOrderNumber | string |
None. |
|
Terms | string |
None. |
|
Taxable | boolean |
None. |
|
OrderStatus | string |
None. |
|
OrderDate | string |
None. |
|
DataInDate | string |
None. |
|
MaterialInDate | string |
None. |
|
ArtworkInDate | string |
None. |
|
DueDate | string |
None. |
|
CloseDate | string |
None. |
|
QuantityExpected | integer |
None. |
|
OrderProgressCode | string |
None. |
|
OrderProgressText | string |
None. |
|
OrderTax | decimal number |
None. |
|
OrderTotal | decimal number |
None. |
|
ShipDate | string |
None. |
|
JobType | string |
None. |
|
PostageTotal | string |
None. |
|
AvailableEarmarkedDeposit | string |
None. |
|
UDFList | StandardUDFList |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderID": 1, "OrderNumber": "sample string 2", "CustomerID": 3, "CustomerName": "sample string 4", "ContactName": "sample string 5", "SalesRepName": "sample string 6", "CSRName": "sample string 7", "ProjectName": "sample string 8", "LicenseeName": "sample string 9", "PurchaseOrderNumber": "sample string 10", "Terms": "sample string 11", "Taxable": true, "OrderStatus": "sample string 13", "OrderDate": "sample string 14", "DataInDate": "sample string 15", "MaterialInDate": "sample string 16", "ArtworkInDate": "sample string 17", "DueDate": "sample string 18", "CloseDate": "sample string 19", "QuantityExpected": 20, "OrderProgressCode": "sample string 21", "OrderProgressText": "sample string 22", "OrderTax": 23.0, "OrderTotal": 24.0, "ShipDate": "sample string 25", "JobType": "sample string 26", "PostageTotal": "sample string 27", "AvailableEarmarkedDeposit": "sample string 28", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" }, "OrderVersionList": [ { "OrderInventoryList": [ { "OrderInventoryID": 1, "OrderID": 2, "VersionID": 3, "ItemID": 4, "Description": "sample string 5", "QuantityNeeded": 1, "Notes": "sample string 6", "ItemCode": "sample string 7", "Value": 8.0, "ItemPerContainer": 9 }, { "OrderInventoryID": 1, "OrderID": 2, "VersionID": 3, "ItemID": 4, "Description": "sample string 5", "QuantityNeeded": 1, "Notes": "sample string 6", "ItemCode": "sample string 7", "Value": 8.0, "ItemPerContainer": 9 } ], "OrderVersionPostageList": [ { "OrderVersionPostageID": 1, "VersionID": 1, "PostageAffixID": 1, "PostageAffixName": "sample string 1", "PostageQuantity": 1, "PostageRate": 1.0, "PostageMarkupType": "sample string 2", "PostageMarkupValue": 1.0, "PostageSellRate": 1.0, "PostageTotal": 1.0, "DateUsed": "sample string 3", "MailClassID": 1, "MailClassName": "sample string 4", "TotalWeight": 1.0, "FormNo": "sample string 5", "LOT": "sample string 6", "PermitNo": "sample string 7", "NonProfit": "sample string 8", "PostOffice": "sample string 9", "POCity": "sample string 10", "POZIP": "sample string 11", "WTStatus": "sample string 12", "ProcessingCategory": "sample string 13", "FTtr1": 1, "FTtr2": 1, "Sacks": 1, "Pallets": 1, "FlatTr": 1, "Other": 1, "TareWt": 1.0, "Precanceled": "sample string 14" }, { "OrderVersionPostageID": 1, "VersionID": 1, "PostageAffixID": 1, "PostageAffixName": "sample string 1", "PostageQuantity": 1, "PostageRate": 1.0, "PostageMarkupType": "sample string 2", "PostageMarkupValue": 1.0, "PostageSellRate": 1.0, "PostageTotal": 1.0, "DateUsed": "sample string 3", "MailClassID": 1, "MailClassName": "sample string 4", "TotalWeight": 1.0, "FormNo": "sample string 5", "LOT": "sample string 6", "PermitNo": "sample string 7", "NonProfit": "sample string 8", "PostOffice": "sample string 9", "POCity": "sample string 10", "POZIP": "sample string 11", "WTStatus": "sample string 12", "ProcessingCategory": "sample string 13", "FTtr1": 1, "FTtr2": 1, "Sacks": 1, "Pallets": 1, "FlatTr": 1, "Other": 1, "TareWt": 1.0, "Precanceled": "sample string 14" } ], "OrderVersionDropList": [ { "OrderVersionDropId": 1, "VersionID": 2, "Quantity": 3, "DropName": "sample string 4", "DropDate": "sample string 5", "TimeDue": "sample string 6", "ActualDrop": "sample string 7", "DropDateComplete": "sample string 8", "PostageValue": 10.0, "UDF1": "sample string 11", "UDF2": "sample string 12", "UDF3": "sample string 13", "UDF4": "sample string 14", "UDF5": "sample string 15" }, { "OrderVersionDropId": 1, "VersionID": 2, "Quantity": 3, "DropName": "sample string 4", "DropDate": "sample string 5", "TimeDue": "sample string 6", "ActualDrop": "sample string 7", "DropDateComplete": "sample string 8", "PostageValue": 10.0, "UDF1": "sample string 11", "UDF2": "sample string 12", "UDF3": "sample string 13", "UDF4": "sample string 14", "UDF5": "sample string 15" } ], "OrderVersionDetailList": [ { "OrderVersionDetailID": 1, "VersionID": 2, "ServiceTypeId": 3, "ServiceTypeName": "sample string 4", "ServiceTypeSort": "sample string 5", "ServiceId": 6, "ServiceCode": "sample string 7", "ServiceName": "sample string 8", "Quantity": 9.0, "UnitPriceNoMarkup": 10.0, "ServiceMarkup": 11.0, "UnitPrice": 12.0, "LineTotal": 13.0, "Taxable": true, "TaxablePercent": 1.0, "TaxAmount": 1.0, "RunRate": 1.0, "RunTime": 1.0, "QtyDone": 1.0, "Complete": true, "PrioritySort": 1, "Comment": "sample string 14", "Priority": 1, "ServiceHyperlink": "sample string 15", "FileLocation": "sample string 16", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" }, "UnitOfMeasureName": "sample string 17" }, { "OrderVersionDetailID": 1, "VersionID": 2, "ServiceTypeId": 3, "ServiceTypeName": "sample string 4", "ServiceTypeSort": "sample string 5", "ServiceId": 6, "ServiceCode": "sample string 7", "ServiceName": "sample string 8", "Quantity": 9.0, "UnitPriceNoMarkup": 10.0, "ServiceMarkup": 11.0, "UnitPrice": 12.0, "LineTotal": 13.0, "Taxable": true, "TaxablePercent": 1.0, "TaxAmount": 1.0, "RunRate": 1.0, "RunTime": 1.0, "QtyDone": 1.0, "Complete": true, "PrioritySort": 1, "Comment": "sample string 14", "Priority": 1, "ServiceHyperlink": "sample string 15", "FileLocation": "sample string 16", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" }, "UnitOfMeasureName": "sample string 17" } ], "VersionID": 1, "OrderID": 2, "Suffix": 3, "Quantity": 4.0, "VersionName": "sample string 5", "SubTotal": 6.0, "TaxAmt": 7.0, "Postage": 8.0, "TotalDue": 9.0, "MailGeographyID": 10, "MailGeographyName": "sample string 11", "MailSortID": 12, "MailSortName": "sample string 13", "MailClassID": 14, "MailClassName": "sample string 15", "MailCategoryID": 16, "MailCategoryName": "sample string 17", "PostOfficeID": 18, "PostOfficeName": "sample string 19", "PostageAffixID": 20, "PostageAffixName": "sample string 21", "PermitNumber": "sample string 22", "PermitHolder": "sample string 23", "MeterNumber": "sample string 24", "PostageRequired": 25.0, "PostageDue": "sample string 26", "PostageStatusID": 27, "DataProcessingOutTime": "sample string 28", "Weight": 29.0, "Thickness": 30.0, "Height": 31.0, "Width": 32.0, "DataProcessingStatusID": 33, "DataProcessingStatusName": "sample string 34", "DataProcessingActualQuantity": 35, "DataProcessingActualBilled": 36.0, "VersionDropDate": "sample string 37", "VersionDropQuantity": 38, "VersionDropName": "sample string 39", "VersionDropActualDate": "sample string 40", "CanadianRecordsID": 41, "CanadianRecordsName": "sample string 42", "ForeignRecordsID": 43, "ForeignRecordsName": "sample string 44", "UnmailablesID": 45, "UnmailablesName": "sample string 46", "VersionComment": "sample string 47", "DPInStartDate": "sample string 48", "DPOutDate": "sample string 49", "DPInitials": "sample string 50", "DataCheckedDate": "sample string 51", "GhostCode": "sample string 52", "NonProfitAuthCode": "sample string 53", "MailerCode": "sample string 54", "CustRegCode": "sample string 55", "Urgency": "sample string 56", "VersionJobType": "sample string 57", "PostageBalance": "sample string 58", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" }, "InvoiceServiceBalance": "sample string 59", "InvoicePostageBalance": "sample string 60", "EarmarkedBalance": "sample string 61" }, { "OrderInventoryList": [ { "OrderInventoryID": 1, "OrderID": 2, "VersionID": 3, "ItemID": 4, "Description": "sample string 5", "QuantityNeeded": 1, "Notes": "sample string 6", "ItemCode": "sample string 7", "Value": 8.0, "ItemPerContainer": 9 }, { "OrderInventoryID": 1, "OrderID": 2, "VersionID": 3, "ItemID": 4, "Description": "sample string 5", "QuantityNeeded": 1, "Notes": "sample string 6", "ItemCode": "sample string 7", "Value": 8.0, "ItemPerContainer": 9 } ], "OrderVersionPostageList": [ { "OrderVersionPostageID": 1, "VersionID": 1, "PostageAffixID": 1, "PostageAffixName": "sample string 1", "PostageQuantity": 1, "PostageRate": 1.0, "PostageMarkupType": "sample string 2", "PostageMarkupValue": 1.0, "PostageSellRate": 1.0, "PostageTotal": 1.0, "DateUsed": "sample string 3", "MailClassID": 1, "MailClassName": "sample string 4", "TotalWeight": 1.0, "FormNo": "sample string 5", "LOT": "sample string 6", "PermitNo": "sample string 7", "NonProfit": "sample string 8", "PostOffice": "sample string 9", "POCity": "sample string 10", "POZIP": "sample string 11", "WTStatus": "sample string 12", "ProcessingCategory": "sample string 13", "FTtr1": 1, "FTtr2": 1, "Sacks": 1, "Pallets": 1, "FlatTr": 1, "Other": 1, "TareWt": 1.0, "Precanceled": "sample string 14" }, { "OrderVersionPostageID": 1, "VersionID": 1, "PostageAffixID": 1, "PostageAffixName": "sample string 1", "PostageQuantity": 1, "PostageRate": 1.0, "PostageMarkupType": "sample string 2", "PostageMarkupValue": 1.0, "PostageSellRate": 1.0, "PostageTotal": 1.0, "DateUsed": "sample string 3", "MailClassID": 1, "MailClassName": "sample string 4", "TotalWeight": 1.0, "FormNo": "sample string 5", "LOT": "sample string 6", "PermitNo": "sample string 7", "NonProfit": "sample string 8", "PostOffice": "sample string 9", "POCity": "sample string 10", "POZIP": "sample string 11", "WTStatus": "sample string 12", "ProcessingCategory": "sample string 13", "FTtr1": 1, "FTtr2": 1, "Sacks": 1, "Pallets": 1, "FlatTr": 1, "Other": 1, "TareWt": 1.0, "Precanceled": "sample string 14" } ], "OrderVersionDropList": [ { "OrderVersionDropId": 1, "VersionID": 2, "Quantity": 3, "DropName": "sample string 4", "DropDate": "sample string 5", "TimeDue": "sample string 6", "ActualDrop": "sample string 7", "DropDateComplete": "sample string 8", "PostageValue": 10.0, "UDF1": "sample string 11", "UDF2": "sample string 12", "UDF3": "sample string 13", "UDF4": "sample string 14", "UDF5": "sample string 15" }, { "OrderVersionDropId": 1, "VersionID": 2, "Quantity": 3, "DropName": "sample string 4", "DropDate": "sample string 5", "TimeDue": "sample string 6", "ActualDrop": "sample string 7", "DropDateComplete": "sample string 8", "PostageValue": 10.0, "UDF1": "sample string 11", "UDF2": "sample string 12", "UDF3": "sample string 13", "UDF4": "sample string 14", "UDF5": "sample string 15" } ], "OrderVersionDetailList": [ { "OrderVersionDetailID": 1, "VersionID": 2, "ServiceTypeId": 3, "ServiceTypeName": "sample string 4", "ServiceTypeSort": "sample string 5", "ServiceId": 6, "ServiceCode": "sample string 7", "ServiceName": "sample string 8", "Quantity": 9.0, "UnitPriceNoMarkup": 10.0, "ServiceMarkup": 11.0, "UnitPrice": 12.0, "LineTotal": 13.0, "Taxable": true, "TaxablePercent": 1.0, "TaxAmount": 1.0, "RunRate": 1.0, "RunTime": 1.0, "QtyDone": 1.0, "Complete": true, "PrioritySort": 1, "Comment": "sample string 14", "Priority": 1, "ServiceHyperlink": "sample string 15", "FileLocation": "sample string 16", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" }, "UnitOfMeasureName": "sample string 17" }, { "OrderVersionDetailID": 1, "VersionID": 2, "ServiceTypeId": 3, "ServiceTypeName": "sample string 4", "ServiceTypeSort": "sample string 5", "ServiceId": 6, "ServiceCode": "sample string 7", "ServiceName": "sample string 8", "Quantity": 9.0, "UnitPriceNoMarkup": 10.0, "ServiceMarkup": 11.0, "UnitPrice": 12.0, "LineTotal": 13.0, "Taxable": true, "TaxablePercent": 1.0, "TaxAmount": 1.0, "RunRate": 1.0, "RunTime": 1.0, "QtyDone": 1.0, "Complete": true, "PrioritySort": 1, "Comment": "sample string 14", "Priority": 1, "ServiceHyperlink": "sample string 15", "FileLocation": "sample string 16", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" }, "UnitOfMeasureName": "sample string 17" } ], "VersionID": 1, "OrderID": 2, "Suffix": 3, "Quantity": 4.0, "VersionName": "sample string 5", "SubTotal": 6.0, "TaxAmt": 7.0, "Postage": 8.0, "TotalDue": 9.0, "MailGeographyID": 10, "MailGeographyName": "sample string 11", "MailSortID": 12, "MailSortName": "sample string 13", "MailClassID": 14, "MailClassName": "sample string 15", "MailCategoryID": 16, "MailCategoryName": "sample string 17", "PostOfficeID": 18, "PostOfficeName": "sample string 19", "PostageAffixID": 20, "PostageAffixName": "sample string 21", "PermitNumber": "sample string 22", "PermitHolder": "sample string 23", "MeterNumber": "sample string 24", "PostageRequired": 25.0, "PostageDue": "sample string 26", "PostageStatusID": 27, "DataProcessingOutTime": "sample string 28", "Weight": 29.0, "Thickness": 30.0, "Height": 31.0, "Width": 32.0, "DataProcessingStatusID": 33, "DataProcessingStatusName": "sample string 34", "DataProcessingActualQuantity": 35, "DataProcessingActualBilled": 36.0, "VersionDropDate": "sample string 37", "VersionDropQuantity": 38, "VersionDropName": "sample string 39", "VersionDropActualDate": "sample string 40", "CanadianRecordsID": 41, "CanadianRecordsName": "sample string 42", "ForeignRecordsID": 43, "ForeignRecordsName": "sample string 44", "UnmailablesID": 45, "UnmailablesName": "sample string 46", "VersionComment": "sample string 47", "DPInStartDate": "sample string 48", "DPOutDate": "sample string 49", "DPInitials": "sample string 50", "DataCheckedDate": "sample string 51", "GhostCode": "sample string 52", "NonProfitAuthCode": "sample string 53", "MailerCode": "sample string 54", "CustRegCode": "sample string 55", "Urgency": "sample string 56", "VersionJobType": "sample string 57", "PostageBalance": "sample string 58", "UDFList": { "UDF1": "sample string 21", "UDF2": "sample string 22", "UDF3": "sample string 23", "UDF4": "sample string 24", "UDF5": "sample string 25", "UDF6": "sample string 26", "UDF7": "sample string 27", "UDF8": "sample string 28", "UDF9": "sample string 29", "UDF10": "sample string 30", "UDF11": "sample string 1", "UDF12": "sample string 2", "UDF13": "sample string 3", "UDF14": "sample string 4", "UDF15": "sample string 5", "UDF16": "sample string 6", "UDF17": "sample string 7", "UDF18": "sample string 8", "UDF19": "sample string 9", "UDF20": "sample string 10", "UDF21": "sample string 11", "UDF22": "sample string 12", "UDF23": "sample string 13", "UDF24": "sample string 14", "UDF25": "sample string 15", "UDF26": "sample string 16", "UDF27": "sample string 17", "UDF28": "sample string 18", "UDF29": "sample string 19", "UDF30": "sample string 20" }, "InvoiceServiceBalance": "sample string 59", "InvoicePostageBalance": "sample string 60", "EarmarkedBalance": "sample string 61" } ] }