Read a shipment request by its business number
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://app.quatlasglobal.com/api/integrations/v1/shipment-requests/by-number/example"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://app.quatlasglobal.com/api/integrations/v1/shipment-requests/by-number/example")) .header("Authorization", "Bearer <token>") .method("GET", HttpRequest.BodyPublishers.noBody()) .build();HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());System.out.println(response.body());const url = 'https://app.quatlasglobal.com/api/integrations/v1/shipment-requests/by-number/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://app.quatlasglobal.com/api/integrations/v1/shipment-requests/by-number/example \ --header 'Authorization: Bearer <token>'Requires the requests:read scope. The request’s business number (REQ-048213), in any case, with or without the REQ- prefix (another kind’s prefix is 400 Integration.InvalidBusinessNumber). Answers exactly as the read by id, ETag included, under the same rules: only your company’s own requests; any other number is 404. A test key reads your sandbox.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”OK
object
The awarded carrier, once a deal exists (when the app names it).
Open offers right now: a count only, never who made them or what they offered.
The reason given when the request was cancelled, if any.
The deal’s business number (DEAL-206447), once a deal exists. Never changes.
True for a live key. False for a test key (qk_test_…): a sandbox request, never real data.
Your own fields on the request: your company’s only, never shown to anyone else. An empty object when there are none.
object
Once a deal exists: Closing, InProgress, Delivered, Completed, Cancelled, Withdrawn or Ended.
The winning quote’s business number (QTE-731905), once a deal exists. Never changes.
The request’s business number (REQ-048213): the number a person reads out and your system can store. Never changes.
Which version of the listing this is: 1 until the first change, then one more for each change of its fields (in the app or through PATCH).
The operation’s business number (SHPT-012618), once the deal went live. Never changes.
Draft, Published, BiddingClosed, Awarded or Cancelled.
Examplegenerated
{ "awardedAt": "2026-04-15T12:00:00Z", "awardedCarrierName": "example", "bidCount": 1, "biddingDeadline": "2026-04-15T12:00:00Z", "cancellationReason": "example", "cancelledAt": "2026-04-15T12:00:00Z", "costCenter": "example", "createdAt": "2026-04-15T12:00:00Z", "dealId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dealNumber": "example", "deliveredAt": "2026-04-15T12:00:00Z", "externalReference": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "livemode": true, "metadata": { "additionalProperty": "example" }, "operationStatus": "example", "publishedAt": "2026-04-15T12:00:00Z", "purchaseOrderNumber": "example", "quoteNumber": "example", "requestNumber": "example", "revision": 1, "shipmentNumber": "example", "status": "example", "webUrl": "example"}Bad Request
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Unauthorized
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Forbidden
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Not Found
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Too Many Requests
object
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}