Shipments
The shipment services provide a mechanism to manage shipments if your company is using ‘Ship via Quipt’. The primary purpose is to download the necessary packing and shipment documents. If you currently do not utilize ‘Ship Via Quipt’ all details can be retrieved here using the order services. Click here for a few use cases using the shipment services.
Get Shipments
This services allows a partner to retrieve a paged list of shipment records.
URLhttps://api.getquipt.com/v2/orders/shipment/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| &statuses | A comma separated list of shipment statuses, (2 = Pending, 32 = New, 128 = Ready, 512 = Generating, 1024 = Generated, 4096 = Exported, 16384 = Printed, 131072 = Pickup Requested, 524288 = Picked Up, 2097152 = Error, 8388608 = Canceled). | String | No |
| &orderIds | A comma separated list of order ids. | String | No |
| &warehouseIds | A comma separated list of warehouses. | String | No |
| &include | A comma separated list of properties to include with result. Valid options are Invoices, PackingSlips, ShipByTruckRequests, and Labels. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/orders/shipment/10/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
{ "Result" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Name", "Code" : "SAMPLECARRIERCODE" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Method Name", "Code" : "SAMPLECARRIERMETHODCODE" }, "Fills" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 2, "PickStatus" : 0, "VendorSKU" : "SAMPLE-VENDOR-SKU", "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Cost" : { "Value" : 0.0000, "Units" : 0 }, "Invoice" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber" : "INV270827SAMPLE-INVOINCE-NUMBER", "InvoicedAt" : "2014-04-21T00:00:00" }, "Line" : { "Fulfillments" : [{ "VendorSKU" : "SAMPLE-VENDOR-SKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "Sample City Name", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 1, "AckAt" : "2014-04-11T09:44:35.12", "Quantity" : { "Units" : 0, "Value" : 1.0000 } } ] } ], "Acknowledgements" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 1, "AckAt" : "2014-04-11T09:44:35.12", "Quantity" : { "Units" : 0, "Value" : 1.0000 } } ], "Item" : { "Title" : "Sample Title", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Condition Name", "Code" : "SAMPLECONDITIONCODE" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SAMPLE-SKU", "Vendor" : { "Code" : "SAMPLEVENDORCODE", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Vendor Name" } }, "Canceled" : { "Units" : 0, "Value" : 0.0000 }, "BackOrdered" : { "ExpectedAt" : null, "Units" : 0, "Value" : 0.0000 }, "Shipped" : { "Units" : 0, "Value" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.0000 }, "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial" : null } ], "Status" : 0, "ErrorMessage" : null, "EstimatedFreight" : null, "InsurableValue" : { "Value" : 39.8800, "Units" : 0 }, "Tracking" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "TrackingURL" : "http://sample.url.com.com", "CreatedAt" : "2014-04-11T23:43:05.433", "CurrentStatus" : 8192, "LastUpdatedAt" : "2014-08-05T03:25:08.84", "EstimatedDelivery" : null, "TrackingNumber" : "SAMPLETRACKINGNUMBER", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Name", "Code" : "SAMPLECARRIERCODE" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Method Name", "Code" : "SAMPLECARRIERMETHODCODE" } }, "Invoices" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber" : "SAMPLEINVOICENUMBER", "InvoicedAt" : "2014-04-21T00:00:00" } ], "Packingslip" : { "Data" : null, "Format" : 0 }, "Labels" : { "Data" : null, "Format" : 0 }, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "Sample City Name", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "ShipAt" : "2015-03-06T00:00:00", "UserDefined1" : null, "UserDefined2" : null, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "CarrierAccountDetails" : null, "SSCC" : null } ], "Paging" : { "PageNumber" : 1, "Total" : 1, "HasMoreRecords" : true }, "TransactionId" : null, "TransactionTime" : "2016-01-04T16:50:10.0378704Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The collection of shipment results. | ShipmentResult[] |
| Paging | Paging information for the records returned. | Paging |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Get Shipment By Id
This services allows a partner to retrieve a specific shipment.
URLhttps://api.getquipt.com/v2/orders/shipment/id/{id}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {id} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| &include | A comma separated list of properties to include with result. Valid options are Invoices, PackingSlips, ShipByTruckRequests, and Labels. | String | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/orders/shipment/id/00000000-0000-0000-0000-000000000000 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Name", "Code" : "SAMPLECARRIERCODE" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Method Name", "Code" : "SAMPLECARRIERMETHODCODE" }, "Fills" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 2, "PickStatus" : 0, "VendorSKU" : "SAMPLE-VENDOR-SKU", "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Cost" : { "Value" : 0.0000, "Units" : 0 }, "Invoice" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber" : "INV270827SAMPLE-INVOINCE-NUMBER", "InvoicedAt" : "2014-04-21T00:00:00" }, "Line" : { "Fulfillments" : [{ "VendorSKU" : "SAMPLE-VENDOR-SKU", "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "Sample City Name", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "Quantity" : { "Units" : 0, "Value" : 2.0000 }, "Serials" : [], "Acknowledgements" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 1, "AckAt" : "2014-04-11T09:44:35.12", "Quantity" : { "Units" : 0, "Value" : 1.0000 } } ] } ], "Acknowledgements" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 1, "AckAt" : "2014-04-11T09:44:35.12", "Quantity" : { "Units" : 0, "Value" : 1.0000 } } ], "Item" : { "Title" : "Sample Title", "Condition" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Condition Name", "Code" : "SAMPLECONDITIONCODE" }, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "OriginalSKU" : null, "MapId" : "SampleMapId", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "SKU" : "SAMPLE-SKU", "Vendor" : { "Code" : "SAMPLEVENDORCODE", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Vendor Name" } }, "Canceled" : { "Units" : 0, "Value" : 0.0000 }, "BackOrdered" : { "ExpectedAt" : null, "Units" : 0, "Value" : 0.0000 }, "Shipped" : { "Units" : 0, "Value" : 0.0000 }, "SubstitutionFor" : null, "LineNumber" : 0, "Ordered" : { "Units" : 0, "Value" : 2.0000 }, "Tax" : { "Value" : 0.0000, "Units" : 0 }, "Miscellaneous" : { "Value" : 0.0000, "Units" : 0 }, "Discount" : { "Value" : 0.0000, "Units" : 0 }, "Freight" : { "Value" : 0.0000, "Units" : 0 }, "Price" : { "Value" : 39.8800, "Units" : 0 }, "UserDefined1" : null, "UserDefined2" : null, "UserDefined3" : null, "RequestedShipDate" : null, "Status" : 4, "StatusAt" : "2015-03-06T23:53:54.783", "SubStatus" : 0, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "Serial" : null } ], "Status" : 0, "ErrorMessage" : null, "EstimatedFreight" : null, "InsurableValue" : { "Value" : 39.8800, "Units" : 0 }, "Tracking" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "TrackingURL" : "http://sample.url.com.com", "CreatedAt" : "2014-04-11T23:43:05.433", "CurrentStatus" : 8192, "LastUpdatedAt" : "2014-08-05T03:25:08.84", "EstimatedDelivery" : null, "TrackingNumber" : "SAMPLETRACKINGNUMBER", "CarrierMethod" : { "Carrier" : { "TrackingURL" : null, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Name", "Code" : "SAMPLECARRIERCODE" }, "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Method Name", "Code" : "SAMPLECARRIERMETHODCODE" } }, "Invoices" : [{ "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber" : "SAMPLEINVOICENUMBER", "InvoicedAt" : "2014-04-21T00:00:00" } ], "Packingslip" : { "Data" : null, "Format" : 0 }, "Labels" : { "Data" : null, "Format" : 0 }, "Warehouse" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "12345", "Address" : { "City" : "Sample City Name", "PostalCode" : "12345", "State" : "CA", "StreetLine1" : "1234 Sample Street Name", "StreetLine2" : "", "StreetLine3" : null, "Country" : { "ISO" : "US", "ISO3" : "USA", "Name" : "United States" } }, "DisplayName" : "City, State" }, "ShipAt" : "2015-03-06T00:00:00", "UserDefined1" : null, "UserDefined2" : null, "Weight" : { "Units" : 10, "Value" : 0.6500 }, "Dimensions" : { "Length" : 6.8, "Width" : 5.5, "Height" : 3.0, "Units" : 0 }, "CarrierAccountDetails" : null, "SSCC" : null } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The shipment result. | ShipmentResult |
Acknowledge Shipment
This services allows a partner to acknowledge the receipt of a shipment.
URLhttps://api.getquipt.com/v2/orders/shipment/acknowledge
Methodpost
Parameters:
| Name | Description | Type |
|---|---|---|
| Acknowledgements | The collection of shipment acknowledgements for the request. | Shipment.Acknowledgement[] |
| TransactionId | The transaction id for the request. | String |
Sample Header:
|
1 2 3 4 |
POST https://api.getquipt.com/v2/orders/shipment/acknowledge Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Request (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
{ "Acknowledgements" : [{ "AckType" : 0, "CancelationDetails" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Code" : "SAMPLECANCELATIONCODE", "Text" : "Sample Text" }, "InvoiceDetails" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "InvoiceNumber" : "SAMPLE-INVOICE-NUMBER", "InvoicedAt" : "2016-01-04T11:46:46.5568074-08:00" }, "ShipmentId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "CarrierMethod" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Carrier" : { "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Name" : "Sample Carrier Name", "Code" : "SAMPLECARRIERCODE" }, "Name" : "Sample Carrier Method Name", "Code" : "SAMPLECARRIERMETHODCODE" }, "TrackingNumber" : "SAMPLETRACKINGNUMBER" } ], "TransactionId" : null } |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 |
{ "ReportId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "RecordsReceived" : 1, "TransactionId" : null, "TransactionTime" : "2016-01-04T17:52:13.8242516Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| ReportId | The id used to lookup report details using the report endpoint. | Guid |
| RecordsReceived | The number of records received. | Int |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |
Batch Report
This service allows a partner to retrieve the detailed report generated when any of the action services are used. The result of ‘Acknowledge Shipment’ returns the {id} used to retrieve the report from this service.
URLhttps://api.getquipt.com/v2/orders/shipment/report/{id}/{pageSize}/{pageNumber}
Methodget
Parameters:
| Name | Description | Type | Required |
|---|---|---|---|
| {pageSize} | The maximum number of records to return. The maximum value is 200. | Int | Yes |
| {pageNumber} | The page to retrieve. | String | No |
| {id} | The report identifier. | Guid | Yes |
| &includeLines | Flag whether or not to include the line details. | Boolean | No |
Sample Header:
|
1 2 3 4 |
GET https://api.getquipt.com/v2/orders/shipment/report/00000000-0000-0000-0000-000000000000/10/1 Authorization: OAuth oauth_consumer_key="XXXXXXXXXX", oauth_nonce="7165911", oauth_signature="uruX2ycflxvq3WYw4DNU0zEN8og%3D", oauth_signature_method="HMAC-SHA1", oauth_timestamp="1448440096", oauth_version="1.0", oauth_token="YYYYYYYYYY" Content-Type: application/json;charset=UTF-8 Accept: */* |
Sample Response (JSON):
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 |
{ "Result" : [{ "ShipmentId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Id" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "Status" : 0, "Message" : "Sample Message", "Record" : 0 } ], "ReportId" : "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "ReportTime" : "2014-07-03T20:33:45.48", "ReportStatus" : 64, "Paging" : { "PageNumber" : 1, "Total" : 1, "HasMoreRecords" : false }, "TransactionId" : null, "TransactionTime" : "2016-01-04T18:45:34.536065Z", "Success" : true, "Messages" : [] } |
Response Definitions:
| Name | Description | Type |
|---|---|---|
| Result | The collection of shipment reports. | ShipmentReport[] |
| ReportId | The report id. | Guid |
| ReportTime | The time the report was generated. | DateTime |
| ReportStatus | The current status of the report. | Int |
| Paging | Paging information for the records returned. | Paging |
| TransactionId | The transaction id for the request. | String |
| TransactionTime | The time the transaction took place. | DateTime |
| Success | Whether or not the transaction was successful. | Boolean |
| Messages | One or more messages may accompany the response. It is important to review the Severity of each message to determine the reason for failure. | Message[] |