Read a deal 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/deals/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/deals/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/deals/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/deals/by-number/example \ --header 'Authorization: Bearer <token>'Requires the deals:read scope. The deal’s business number (DEAL-206447), in any case, with or without the DEAL- prefix (another kind’s prefix is 400 Integration.InvalidBusinessNumber). Answers exactly as the read by id: a deal your company is not a party to, or a number that does not exist, is 404.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Responses
Section titled “Responses”OK
object
The agreed price: a renegotiated price when the parties accepted one, else the winning offer’s amount.
When the deal ended: delivery confirmed (Completed) or withdrawn (Withdrawn). Null while it runs.
The other party’s company name, which the app shows both sides once a deal exists.
ISO 4217 currency of the agreed price.
The deal’s business number (DEAL-206447). Never changes.
Your own reference for the request, when your company owns it (the shipper side). Null on the carrier side.
Incoterms 2020 code the deal runs on, when one was stated.
True for a live key. False for a test key: a sandbox deal, never real data.
The winning quote’s business number (QTE-731905).
The business number of the request the deal was made from (REQ-048213).
The operation’s business number (SHPT-012618), once the deal went live. Never changes.
Your company’s side of the deal: Shipper or Carrier.
Closing (closing room), Live (the operation runs), Completed (delivery confirmed) or Withdrawn (called off in the closing room).
When the closing room finished and the deal went live.
Examplegenerated
{ "agreedAmount": 1, "closedAt": "2026-04-15T12:00:00Z", "counterpartyName": "example", "createdAt": "2026-04-15T12:00:00Z", "currency": "example", "dealNumber": "example", "externalReference": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "incoterm": "example", "livemode": true, "quoteNumber": "example", "requestNumber": "example", "shipmentNumber": "example", "shipmentRequestId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "side": "example", "stage": "example", "wentLiveAt": "2026-04-15T12:00:00Z"}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"}