Retrieves a single sales quotation by its ID

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/sales-quotations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-quotations/{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://api.jtl-cloud.com/erp/v2/sales-quotations/{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>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentInfo": {
    "accountHolder": "<string>",
    "bankName": "<string>",
    "bIC": "<string>",
    "creditorId": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "endToEndId": "<string>",
    "iBAN": "<string>",
    "mandateReference": "<string>",
    "paymentInfo": "<string>",
    "paymentInfoType": 123,
    "paymentReference": "<string>",
    "referenceEmail": "<string>"
  },
  "text": {
    "comment": "<string>",
    "customerComment": "<string>",
    "printText": "<string>",
    "processStatus": "<string>"
  },
  "salesQuotationDate": "2023-11-07T05:31:56Z",
  "isCancelled": true,
  "isPending": true,
  "salesQuotationStatus": 123,
  "salesQuotationNumber": "<string>",
  "departureCountry": {
    "countryIso": "<string>",
    "currencyIso": "<string>",
    "currencyFactor": 123,
    "stateCode": "<string>"
  },
  "externalDetails": {
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "externalSalesQuotationNumber": "<string>"
  },
  "paymentDetails": {
    "cashDiscount": 123,
    "cashDiscountDays": 123,
    "financingCosts": 123,
    "paymentDueDateInDays": 123,
    "currencyIso": "<string>",
    "currencyFactor": 123
  },
  "shippingDetails": {
    "deliveryFromDate": "2023-11-07T05:31:56Z",
    "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
    "extraWeight": 123,
    "maxDeliveryDays": 123,
    "shippingDate": "2023-11-07T05:31:56Z",
    "shippingPriority": 123
  },
  "taxDetails": {},
  "processColourId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "cartonItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "processStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "languageIso": "<string>",
  "customerSalesQuotationNumber": "<string>",
  "vatId": "<string>",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shipmentAddress": {
    "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "billingAddress": {
    "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "lineItems": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "sku": "<string>",
      "isReserved": true,
      "name": "<string>",
      "fnSku": "<string>",
      "quantity": 123,
      "salesUnit": "<string>",
      "salesPriceNet": 123,
      "salesPriceGross": 123,
      "discountPercent": 123,
      "purchasePriceNet": 123,
      "taxRate": 123,
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "note": "<string>",
      "totalSalesPriceNet": 123,
      "totalSalesPriceGross": 123,
      "sortOrder": 123,
      "standardName": "<string>",
      "hasUpload": true,
      "parentSalesQuotationLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "keyFigures": {
    "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "totalGrossAmount": 123,
    "totalNetAmount": 123,
    "totalGrossAmountExcludingShipping": 123,
    "totalNetAmountExcludingShipping": 123,
    "shippingCostNet": 123,
    "shippingCostGross": 123,
    "vatAmounts": [
      {
        "taxRate": 123,
        "vatAmount": 123
      }
    ]
  }
}

GET

sales-quotations

{id}

Retrieves a single sales quotation by its ID

curl --request GET \
  --url https://api.jtl-cloud.com/erp/v2/sales-quotations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-tenant-id: <x-tenant-id>'

import requests

url = "https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}"

headers = {
    "x-tenant-id": "<x-tenant-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-tenant-id': '<x-tenant-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.jtl-cloud.com/erp/v2/sales-quotations/{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://api.jtl-cloud.com/erp/v2/sales-quotations/{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>",
    "x-tenant-id: <x-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-tenant-id", "<x-tenant-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}")
  .header("x-tenant-id", "<x-tenant-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jtl-cloud.com/erp/v2/sales-quotations/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-tenant-id"] = '<x-tenant-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentInfo": {
    "accountHolder": "<string>",
    "bankName": "<string>",
    "bIC": "<string>",
    "creditorId": "<string>",
    "dueDate": "2023-11-07T05:31:56Z",
    "endToEndId": "<string>",
    "iBAN": "<string>",
    "mandateReference": "<string>",
    "paymentInfo": "<string>",
    "paymentInfoType": 123,
    "paymentReference": "<string>",
    "referenceEmail": "<string>"
  },
  "text": {
    "comment": "<string>",
    "customerComment": "<string>",
    "printText": "<string>",
    "processStatus": "<string>"
  },
  "salesQuotationDate": "2023-11-07T05:31:56Z",
  "isCancelled": true,
  "isPending": true,
  "salesQuotationStatus": 123,
  "salesQuotationNumber": "<string>",
  "departureCountry": {
    "countryIso": "<string>",
    "currencyIso": "<string>",
    "currencyFactor": 123,
    "stateCode": "<string>"
  },
  "externalDetails": {
    "externalCreatedDate": "2023-11-07T05:31:56Z",
    "externalSalesQuotationNumber": "<string>"
  },
  "paymentDetails": {
    "cashDiscount": 123,
    "cashDiscountDays": 123,
    "financingCosts": 123,
    "paymentDueDateInDays": 123,
    "currencyIso": "<string>",
    "currencyFactor": 123
  },
  "shippingDetails": {
    "deliveryFromDate": "2023-11-07T05:31:56Z",
    "estimatedDeliveryDate": "2023-11-07T05:31:56Z",
    "extraWeight": 123,
    "maxDeliveryDays": 123,
    "shippingDate": "2023-11-07T05:31:56Z",
    "shippingPriority": 123
  },
  "taxDetails": {},
  "processColourId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "onHoldReasonId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "cartonItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "paymentMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shippingMethodId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "processStatusId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "languageIso": "<string>",
  "customerSalesQuotationNumber": "<string>",
  "vatId": "<string>",
  "companyId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
  "shipmentAddress": {
    "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "billingAddress": {
    "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "customerId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "salutation": "<string>",
    "title": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "company": "<string>",
    "additionalCompanyLine": "<string>",
    "street": "<string>",
    "additionalAddressLine": "<string>",
    "city": "<string>",
    "postalCode": "<string>",
    "state": "<string>",
    "countryIso": "<string>",
    "postId": "<string>",
    "emailAddress": "<string>",
    "phoneNumber": "<string>",
    "mobilePhoneNumber": "<string>",
    "fax": "<string>",
    "country": "<string>",
    "customsDocumentsRequired": true,
    "vatId": "<string>"
  },
  "lineItems": [
    {
      "id": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "itemId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "sku": "<string>",
      "isReserved": true,
      "name": "<string>",
      "fnSku": "<string>",
      "quantity": 123,
      "salesUnit": "<string>",
      "salesPriceNet": 123,
      "salesPriceGross": 123,
      "discountPercent": 123,
      "purchasePriceNet": 123,
      "taxRate": 123,
      "taxClassId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "taxCodeId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
      "note": "<string>",
      "totalSalesPriceNet": 123,
      "totalSalesPriceGross": 123,
      "sortOrder": 123,
      "standardName": "<string>",
      "hasUpload": true,
      "parentSalesQuotationLineItemId": "b45f6432-2462-4c6f-b00f-1d9d01000000"
    }
  ],
  "keyFigures": {
    "salesQuotationId": "b45f6432-2462-4c6f-b00f-1d9d01000000",
    "totalGrossAmount": 123,
    "totalNetAmount": 123,
    "totalGrossAmountExcludingShipping": 123,
    "totalNetAmountExcludingShipping": 123,
    "shippingCostNet": 123,
    "shippingCostGross": 123,
    "vatAmounts": [
      {
        "taxRate": 123,
        "vatAmount": 123
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid

string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id

string<uuid>

required

The tenant ID for the target ERP instance.

Path Parameters

string<uuid>

required

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

Response

A single sales quotation.

string<uuid>

Unique ID to identify a sales quoation.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

customerId

string<uuid>

Customer this SalesQuotation belongs to.

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

paymentInfo

object

SalesQuotationPaymentInfo

Show child attributes

text

object

SalesQuotationText

Show child attributes

salesQuotationDate

string<date-time>

The SalesQuotation Date

isCancelled

boolean

Indicates if the quotation has been cancelled.

isPending

boolean

The SalesQuotation IsPending

itemDescriptionType

enum<integer>

The SalesQuotation ItemDescriptionType

Available options:

0,

1,

2

readOnlyType

enum<integer>

The SalesQuotation ReadOnlyType

Available options:

0,

1,

2

salesQuotationStatus

integer<int32>

The SalesQuotation Status

salesQuotationNumber

string

The SalesQuotation SalesQuotationNumber

departureCountry

object

DepartureCountry

Show child attributes

externalDetails

object

ExternalDetails

Show child attributes

paymentDetails

object

PaymentDetails

Show child attributes

shippingDetails

object

ShippingDetails

Show child attributes

taxDetails

object

TaxDetails

Show child attributes

processColourId

string<uuid>

The SalesQuotation Process colour id

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

onHoldReasonId

string<uuid>

The SalesQuotation OnHold reason id

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

cartonItemId

string<uuid>

The SalesQuotation Carton item id

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

paymentMethodId

string<uuid>

The SalesQuotation Payment method id

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

shippingMethodId

string<uuid>

The SalesQuotation Shipping method id

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

processStatusId

string<uuid>

The SalesQuotation Process status id

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

languageIso

string

The SalesQuotation Language iso code

customerSalesQuotationNumber

string

The SalesQuotation Customer sales quotation number

vatId

string

The SalesQuotation Vat Id

companyId

string<uuid>

The SalesQuotation Company Id

Example:

"b45f6432-2462-4c6f-b00f-1d9d01000000"

shipmentAddress

object

SalesQuotationShippingAddress

Show child attributes

billingAddress

object

SalesQuotationBillingAddress

Show child attributes

lineItems

object[]

List of SalesQuotationLineItem

Show child attributes

keyFigures

object

Key figures of the sales quotation.

Show child attributes

Creates a new sales quotation.Modifies an existing sales quotation.

⌘I

Overview

GraphQL

REST API

Retrieves a single sales quotation by its ID

Authorizations

Headers

Path Parameters

Response