Read an operation by its business number
GET
/api/integrations/v1/operations/by-number/{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/operations/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/operations/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/operations/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/operations/by-number/example \ --header 'Authorization: Bearer <token>'Requires the tracking:read scope. The operation’s business number (SHPT-012618), in any case, with or without the SHPT- prefix (another kind’s prefix is 400 Integration.InvalidBusinessNumber). Answers exactly as /deals/{id}/tracking for its deal: an operation of 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”number
required
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
cancelledAt
required
When the operation was cancelled after going live, if it was.
null | string format: date-time
completedAt
required
When the shipper confirmed the delivery.
null | string format: date-time
currentEta
required
The carrier’s latest delivery estimate (the planned date until it is revised).
null | string format: date
dealId
required
string format: uuid
dealNumber
The deal’s business number (DEAL-206447).
null | string
deliveredAt
required
null | string format: date-time
etaRevisedAt
required
null | string format: date-time
livemode
required
boolean
milestones
required
Array<object>
object
location
required
The place the carrier named, as text. Never coordinates.
null | string
occurredAt
required
string format: date-time
type
required
Loaded, Departed, Arrived, InTransit, AtCustoms, ModeHandover, OutForDelivery, Delivered, Exception, Refused or PartiallyDelivered.
string
plannedEta
required
The delivery date agreed when the deal went live: the promise a delivery is judged against.
null | string format: date
proofOfDelivery
required
Whether a proof of delivery was captured.
boolean
shipmentNumber
The operation’s business number (SHPT-012618). Never changes.
null | string
Examplegenerated
{ "cancelledAt": "2026-04-15T12:00:00Z", "completedAt": "2026-04-15T12:00:00Z", "currentEta": "2026-04-15", "dealId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dealNumber": "example", "deliveredAt": "2026-04-15T12:00:00Z", "etaRevisedAt": "2026-04-15T12:00:00Z", "livemode": true, "milestones": [ { "location": "example", "occurredAt": "2026-04-15T12:00:00Z", "type": "example" } ], "plannedEta": "2026-04-15", "proofOfDelivery": true, "shipmentNumber": "example"}Bad Request
Media typeapplication/problem+json
object
detail
null | string
instance
null | string
status
null | integer | string format: int32
title
null | string
type
null | string
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Unauthorized
Media typeapplication/problem+json
object
detail
null | string
instance
null | string
status
null | integer | string format: int32
title
null | string
type
null | string
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Forbidden
Media typeapplication/problem+json
object
detail
null | string
instance
null | string
status
null | integer | string format: int32
title
null | string
type
null | string
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Not Found
Media typeapplication/problem+json
object
detail
null | string
instance
null | string
status
null | integer | string format: int32
title
null | string
type
null | string
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Too Many Requests
Media typeapplication/problem+json
object
detail
null | string
instance
null | string
status
null | integer | string format: int32
title
null | string
type
null | string
Examplegenerated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}