Skip to content

List the deals made from a request

GET
/api/integrations/v1/deals
curl --request GET \
--url https://app.quatlasglobal.com/api/integrations/v1/deals \
--header 'Authorization: Bearer <token>'

Requires the deals:read scope and exactly one of shipmentRequestId or externalReference (your own reference, for a request your company owns). Lists only the deals your company is a party to, oldest first; a request re-awarded after a withdrawal has more than one.

shipmentRequestId
string format: uuid
externalReference
string

OK

Media typeapplication/json
object
items
required
Array<object>
object
agreedAmount
required

The agreed price: a renegotiated price when the parties accepted one, else the winning offer’s amount.

null | number | string format: double
/^-?(?:0|[1-9]\d*)(?:\.\d+)?$/
closedAt
required

When the deal ended: delivery confirmed (Completed) or withdrawn (Withdrawn). Null while it runs.

null | string format: date-time
counterpartyName
required

The other party’s company name, which the app shows both sides once a deal exists.

null | string
createdAt
required
string format: date-time
currency
required

ISO 4217 currency of the agreed price.

null | string
dealNumber

The deal’s business number (DEAL-206447). Never changes.

null | string
externalReference
required

Your own reference for the request, when your company owns it (the shipper side). Null on the carrier side.

null | string
id
required
string format: uuid
incoterm
required

Incoterms 2020 code the deal runs on, when one was stated.

null | string
livemode
required

True for a live key. False for a test key: a sandbox deal, never real data.

boolean
quoteNumber

The winning quote’s business number (QTE-731905).

null | string
requestNumber

The business number of the request the deal was made from (REQ-048213).

null | string
shipmentNumber

The operation’s business number (SHPT-012618), once the deal went live. Never changes.

null | string
shipmentRequestId
required
string format: uuid
side
required

Your company’s side of the deal: Shipper or Carrier.

string
stage
required

Closing (closing room), Live (the operation runs), Completed (delivery confirmed) or Withdrawn (called off in the closing room).

string
wentLiveAt
required

When the closing room finished and the deal went live.

null | string format: date-time
livemode
required
boolean
Examplegenerated
{
"items": [
{
"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"
}
],
"livemode": true
}

Bad Request

Media typeapplication/problem+json
object
detail
null | string
instance
null | string
status
null | integer | string format: int32
/^-?(?:0|[1-9]\d*)$/
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
/^-?(?:0|[1-9]\d*)$/
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
/^-?(?:0|[1-9]\d*)$/
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
/^-?(?:0|[1-9]\d*)$/
title
null | string
type
null | string
Examplegenerated
{
"detail": "example",
"instance": "example",
"status": 1,
"title": "example",
"type": "example"
}