Quantum View Example Request
POST {{base_url}}/api/quantumview/:version/events
This HTTP POST request allows the user to retrieve shipment details for either a given subscription, or retrieve additional details based on a bookmark.
Request Body
{"QuantumViewRequest"=>{"Request"=>{"TransactionReference"=>{"CustomerContext"=>"", "XpciVersion"=>"1.0007"}, "RequestAction"=>"QVEvents"}, "SubscriptionRequest"=>{"FileName"=>"220104_140019001", "Name"=>"OutboundXML", "Bookmark"=>"WE9MVFFBMQ=="}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"QuantumViewResponse":{"QuantumViewEvents":{"SubscriberID":"SubScriptAll","SubscriptionEvents":{"Name":"OutboundFull","Number":"45BD09FCCEEA27BA","SubscriptionFile":[{"FileName":"Subscription_FileName","Manifest":[{"BillToAccount":{"Number":"QVDR01","Option":"01"},"DocumentsOnly":"3","Package":{"Activity":{"Date":"20070824","Time":"132526"},"Description":"MerchandiseDescription","DimensionalWeight":{"UnitOfMeasurement":{"Code":"LBS"},"Weight":"0000020"},"Dimensions":{"Height":"00000000","Length":"00000000","Width":"00000000"},"PackageServiceOptions":{"COD":""},"PackageWeight":{"Weight":"+0002.0"},"ReferenceNumber":[{"Code":"00","Value":"123456789"},{"Code":"PO","Value":"444789"},{"Code":"00","Value":"A1"}],"TrackingNumber":"TrackingNumber"},"PickupDate":"20070824","ReferenceNumber":[{"Code":"00","Value":"123456789"},{"Code":"PO","Value":"444789"}],"Service":{"Code":"001"},"ShipmentChargeType":"P/P","ShipmentServiceOptions":{"CallTagARS":{"Code":"8"}},"Shipper":{"Address":{"AddressLine1":"3406 BUFORD HWY","City":"DULUTH","CountryCode":"US","PostalCode":"300963551","StateProvinceCode":"GA"},"Name":"BILLY CO","ShipperNumber":"ShipperNumber"},"ShipTo":{"Address":{"AddressLine1":"26021 ATLANTIC OCEAN DRIVE","City":"LAKE FOREST","ConsigneeName":"RSD","CountryCode":"US","PostalCode":"926308831","StateProvinceCode":"CA"}}},{"BillToAccount":{"Number":"QVDR01","Option":"01"},"DocumentsOnly":"3","Package":{"Activity":{"Date":"20070824","Time":"134527"},"Description":"MerchandiseDescription","DimensionalWeight":{"UnitOfMeasurement":{"Code":"LBS"},"Weight":"0000020"},"Dimensions":{"Height":"00000000","Length":"00000000","Width":"00000000"},"PackageServiceOptions":{"COD":""},"PackageWeight":{"Weight":"+0002.0"},"ReferenceNumber":{"Code":"PO","Value":"444789"},"TrackingNumber":"TrackingNumber"},"PickupDate":"20070824","ReferenceNumber":[{"Code":"00","Value":"123456789"},{"Code":"PO","Value":"444789"}],"Service":{"Code":"001"},"ShipmentChargeType":"P/P","ShipmentServiceOptions":{"CallTagARS":{"Code":"8"}},"Shipper":{"Address":{"AddressLine1":"3406 BUFORD HWY","City":"DULUTH","CountryCode":"US","PostalCode":"300963551","StateProvinceCode":"GA"},"Name":"BILLY CO","ShipperNumber":"QVDR01"},"ShipTo":{"Address":{"AddressLine1":"26021 ATLANTIC OCEAN DRIVE","City":"LAKE FOREST","ConsigneeName":"RSD","CountryCode":"US","PostalCode":"926308831","StateProvinceCode":"CA"}}}],"StatusType":{"Code":"U","Description":"Unread"}},{"FileName":" Subscription_FileName ","Generic":[{"Activity":{"Date":"20070824","Time":"130533"},"ActivityType":"VM","BillToAccount":{"Number":"QVDR03","Option":"03"},"Service":{"Code":"001"},"ShipperNumber":"QVDR01","ShipTo":{"ReceivingAddressName":"RSDTCNTRL-LAKEFOREST"},"TrackingNumber":"TrackingNumber"},{"Activity":{"Date":"20070824","Time":"134438"},"ActivityType":"VM","BillToAccount":{"Number":"QVDR03","Option":"03"},"Service":{"Code":"001"},"ShipperNumber":"QVDR01","ShipTo":{"ReceivingAddressName":"RSDTCNTRL-LAKEFOREST"},"TrackingNumber":"TrackingNumber"}],"StatusType":{"Code":"U","Description":"Unread"}},{"Exception":{"BillToAccount":{"Number":"QVDR03","Option":"03"},"Date":"20070824","ReasonCode":"78","ReasonDescription":"THE SHIPPER HAS REQUESTED A DELIVERY INTERCEPT FOR THIS PACKAGE","Resolution":{"Code":"AH","Description":"THE ADDRESS HAS BEEN CORRECTED. THE DELIVERY HAS BEEN RESCHEDULED"},"ShipperNumber":"QVDR01","Time":"101000","TrackingNumber":"TrackingNumber","UpdatedAddress":{"ConsigneeName":"MMX","CountryCode":"US","PoliticalDivision1":"GA","PoliticalDivision2":"ATLANTA","PostcodePrimaryLow":"30350","StreetName":"SANDALWOOD","StreetNumberLow":"1801","StreetType":"DR"}},"FileName":"Subscription_FileName","Origin":{"ActivityLocation":{"AddressArtifactFormat":{"CountryCode":"US","PoliticalDivision1":"GA","PoliticalDivision2":"ROSWELL-ROSWELL"}},"BillToAccount":{"Number":"QVDR03","Option":"03"},"Date":"20070824","PackageReferenceNumber":[{"Code":"00","Value":"QAST ROW PKG 01"},{"Code":"33","Value":"12345"}],"ShipmentReferenceNumber":{"Code":"00","Value":"04ROW01"},"ShipperNumber":"QVDR01","Time":"101000","TrackingNumber":"TrackingNumber"},"StatusType":{"Code":"U","Description":"Unread"}}],"SubscriptionStatus":{"Code":"A","Description":"Active"}}},"Response":{"ResponseStatusCode":"1","ResponseStatusDescription":"Success","TransactionReference":""}}}