Technical
description scope-rest-webservices
Order API
Purpose
The order API provides endpoints for retrieving order/shipment data in an XML data format from Scope. It is primarily designed for statistical analysis, reporting, and serving as a data source for external systems requiring basic shipment information.
This API does not support data modification. It is not suitable for operational processes such as shipment consolidation, as it provides only basic shipment details rather than comprehensive shipment data.
The API includes the following data:
- Basic order/shipment data
- Airfreight-related data
- Seafreight-related data, including container information
- Dangerous goods information
- Financial data
- Carbon footprint calculations
- Transport order data
- Customs order data
- Shipment milestones from tracking templates
- Reference numbers
- Jobcosting entries
Delta query
The API offers a delta query endpoint for change tracking, enabling applications to retrieve newly created or updated orders/shipments using a pull model. This approach eliminates the need for a full data read each time.
To integrate for example an external data warehouse with Scope, a one-time initial query loads all orders/shipments. Subsequent updates are then captured using the delta query option.
Please note that the delta query endpoint can only access orders/shipments modified within the last 60 days.
API response
The API returns data a XML format.
Current XML schema version 3: order-v3.xsd
Imported schemas:
Examples:
Starting with version 3, a new naming scheme has been introduced. Schema files for previous versions are not available online.
API documentation
The API is documented using an OpenAPI specification, enabling tools like Swagger to visualize the API and generate code in multiple programming languages.
Version 3: order-api-3.0.json