Technical
description scope-rest-webservices
Quotation API
Overview
The Quotation API provides endpoints to create, manage, and retrieve quotations in Scope. A quotation represents a commercial offer for a customer shipment request.
A quotation may contain multiple options. Each option represents a distinct transport solution with its own routing, carriers, and pricing. For example, a direct flight versus a multi-leg connection or services operated by different airlines.
The API supports the following operations when fully implemented:
- Create and retrieve quotations
- Create and delete quotation options
- Calculate quotations based on activity types and tariffs within scope
- Update quotation status following an acceptance or rejection
- Create shipments or bookings from existing quotations
⚠️ Stability notice
This API is under active development. Some endpoints are not fully implemented. The API contract, including request/response schemas and behavior, may change without prior notice.
Quotation resource
The quotation resource includes the following information:
- General quotation information, including prospect details, origin and destination locations, and goods information
- One or more quotation options, including details such as carriers or products
- Income and cost details for each quotation option
- Carbon footprint calculation results for quotation options
- Reference numbers
- Internal operational notes
- Documents associated with the quotation
Planned Enhancements
The following information is planned for inclusion in future releases:
- Multiple main transport legs such as flights or ocean vessels
- Taxes for incomes, when taxes are enabled for quotations in Scope
Limitations
The following limitations currently apply:
- The API does not support the creation of quotations containing Dangerous Goods (DGR) information
Master data references
The Quotation API references the following master data entities. These entities are typically referenced by using identifiers or standardized codes and should not be embedded as full objects.
| Master data entity | Reference details |
|---|---|
| Owner | Each quotation is owned by a branch in Scope. A branch is represented by a branch partner. Branch partners can be queried with a filter option branchPartnersOnly using the Partner API |
| Prospect, shipper or consignee | Can either be a Scope partner or postal address. Scope partners can be referenced by identifier or customer identification number. See Partner API |
| Sales person | Referenced by identifier, see Salesperson API |
| Package types | Scope package types are referenced by their immutable package type code. |
| Air carrier | Air carriers are referenced using IATA airline codes or AWB prefixes. |
| Sea container types | Seafreight containers are referenced using ISO-6346 container codes. |
| Sea / ocean carrier | Sea carriers are referenced using SCAC codes. |
| Booking agent | Seafreight booking agents are Scope partners with the role liner agent. Referenced by identifier or customer identification number, see Partner API |
| Road carrier | Road carriers are Scope partners with the role road carrier. Referenced by identifier or customer identification number, see Partner API |
| Buying products | Referenced by identifier. A Product API is planned. |
| Selling products | Referenced by identifier. A Product API is planned. |
| Charge types | Referenced by identifier, see Charge Type API |
| Cost center | Cost centers are optional and should only be set when explicitly required. Referenced by identifier. A Cost Center API is planned. |
| Airports | Referenced using three-letter IATA airport codes. |
| UN/Locodes | Referenced using five-letter codes for trade and transport locations. |
| Currency | Referenced using ISO-4217 three-letter currency codes. |
| Country | Referenced using ISO 3166-1 two-letter country codes. |
API request & response
The API supports both XML and JSON responses. Regardless of the selected format, the returned data follows the same logical structure and contains the same information.
Current XML schema version 1: quotation-v1.xsd
Imported schemas:
Example requests for creating new quotations:
- Air: quotation-air-creation-1.0.xml
- Sea FCL: quotation-seafcl-creation-1.0.xml
- Sea LCL: quotation-sealcl-creation-1.0.xml
- Simple shipment road: quotation-sh-creation-1.0.xml
Example requests for creating new quotation options:
API documentation
The API is described using the OpenAPI Specification (OAS), enabling tools such as Swagger UI and OpenAPI Generator to visualize the API and generate client code for a wide range of programming languages.
Version 1
- Open in Swagger Editor Next
- Specification file: quotation-api-1.0.json