curl --request GET \
--url https://coreapi.io/api/offers/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/offers/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/api/offers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/api/offers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "<string>",
"number": "<string>",
"status": "open",
"acceptanceMode": "click",
"dealType": "new_business",
"recipients": [
{
"email": "jsmith@example.com",
"role": "read",
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
],
"documents": {
"signed": {
"id": "<string>",
"filename": "<string>",
"url": "<string>"
},
"auditLog": {
"id": "<string>",
"filename": "<string>",
"url": "<string>"
},
"purchaseOrder": {
"id": "<string>",
"filename": "<string>",
"url": "<string>"
}
},
"name": "<string>",
"locale": "de",
"validUntil": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"issuedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"contractValue": {
"amount": 123,
"currencyCode": "EUR",
"precision": 123
},
"proposal": {},
"sections": [
{}
],
"autoActivateSubscription": true,
"customVariables": {},
"links": {
"self": "<string>",
"approval": "<string>"
},
"customer": {
"id": "<string>",
"name": "<string>"
},
"subscription": {
"id": "<string>",
"number": "<string>"
},
"contactPerson": {
"id": "<string>",
"name": "<string>"
},
"salesChannel": {
"id": "<string>",
"name": "<string>",
"brandName": "<string>"
}
}Get an offer
Beta. This endpoint is unstable and may still change without notice. Pin against the dated version and watch the changelog.
Returns the canonical v2 offer resource: structured contract value, grouped documents, recipients and links. The approval state is never embedded; fetch it via GET /api/offers//approval. This replaces the deprecated GET /offers/.
curl --request GET \
--url https://coreapi.io/api/offers/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://coreapi.io/api/offers/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://coreapi.io/api/offers/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://coreapi.io/api/offers/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"id": "<string>",
"number": "<string>",
"status": "open",
"acceptanceMode": "click",
"dealType": "new_business",
"recipients": [
{
"email": "jsmith@example.com",
"role": "read",
"id": "<string>",
"firstName": "<string>",
"lastName": "<string>"
}
],
"documents": {
"signed": {
"id": "<string>",
"filename": "<string>",
"url": "<string>"
},
"auditLog": {
"id": "<string>",
"filename": "<string>",
"url": "<string>"
},
"purchaseOrder": {
"id": "<string>",
"filename": "<string>",
"url": "<string>"
}
},
"name": "<string>",
"locale": "de",
"validUntil": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"issuedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"contractValue": {
"amount": 123,
"currencyCode": "EUR",
"precision": 123
},
"proposal": {},
"sections": [
{}
],
"autoActivateSubscription": true,
"customVariables": {},
"links": {
"self": "<string>",
"approval": "<string>"
},
"customer": {
"id": "<string>",
"name": "<string>"
},
"subscription": {
"id": "<string>",
"number": "<string>"
},
"contactPerson": {
"id": "<string>",
"name": "<string>"
},
"salesChannel": {
"id": "<string>",
"name": "<string>",
"brandName": "<string>"
}
}Autorisierungen
API token of the organisation. Send it as Authorization: Bearer api_... The token is bound to exactly one organisation.
Pfadparameter
Offer ID (ULID).
Antwort
The offer resource.
The canonical v2 representation of an offer.
Stable offer identifier (ULID).
Human-readable offer number, e.g. ANG-1042.
open, signing, awaiting_invoice_details, signed, archived click, esignature, print new_business, expansion, renewal, one_off Show child attributes
Show child attributes
Grouped offer documents. Each slot is null until the document exists.
Show child attributes
Show child attributes
Optional internal title.
"de"
When the offer was first published.
Total contract value. Null if not computable yet.
Show child attributes
Show child attributes
Computed pricing model. Null if the offer carries no priced proposal.
Document blocks that make up the offer body.
Custom template variables as name to value.
Show child attributes
Show child attributes
Related sub-resources (HATEOAS).
Show child attributes
Show child attributes
Linked customer. Null if the offer is not linked yet.
Show child attributes
Show child attributes
Linked subscription. Set when the offer extends or renews an existing subscription, and also once an accepted offer has been converted into a subscription. Null when the offer is not linked to a subscription.
Show child attributes
Show child attributes
Primary contact person. Null if none is set.
Show child attributes
Show child attributes
Sales channel the offer belongs to.
Show child attributes
Show child attributes
War diese Seite hilfreich?