Fast order Integration (EN)

1. Description

The fastest way to choose the best offer and place an order is through the endpoint Simplified order placement - new.

It is a combination of several points from Full Integration (EN) in one. Instead of asking about all the products and addons and then placing the order, the system will automatically find the best (cheapest) offer and take it into execution.

The endpoint structure is similar to endpoints Get products, Get order price and Create order.

2. Structure

You can use the strategy description Full Integration (EN) to build a query, and the key differences are:

in the shipment section:

there is no productId (we do not indicate a specific product)

the integrationName appears - the code of the carrier we want to send the shipment with. The codes can be downloaded from the endpoint described here: Get carrier data (EN) e.g. DPD, DHL

in the addons section we provide categories of additional services (add-ons) that we are interested in ordering along with the shipment (list: Addon categories (EN))
np. "addons": {
"INSURANCE": {
"value": 100
}}

3. Action

For the given parameters, the system will try to find the cheapest offer that meets all the requirements. If a pointId is provided in the senderAddress section, the system will look for an offer that is shipped from a point (not necessarily with a courier pickup option -> instead of DPD, the DPD Pickup option will be selected).

4. Operation control

In the URL, by providing the createFully and onlyPricing parameters, we decide on the type of algorithm to be used:

Parameter	Action
onlyPricing = true	The system will return a response with calculated rates and information about assigned allowances (similarly to the endpoint Get order price)
createFully = true	The system will automatically create the order both in the Globkurier system and forward it to the carrier. Similarly to the endpoint Create order

5. Response errors

There are several possible system responses due to the error:

Response	Explanation
"fields": {"addons[RETURN_SHIPMENT][id]": "This value is not available"}	No such add-on can be found for the specified parameters. The specified add-on should be deleted
{"fields": {"collectionType": "No product was found for the specified collection type."}}	No product found for the given shipping type (you need to change either the courier or the shipping type)
{"fields": {"shipment[integrationName]": "This offer is not available for given carrier."}}	There are no offers for the selected courier, shipping type and delivery type

6. Correct answer

After implementation

Fast order Integration (EN)

1. Description#

2. Structure#

3. Action#

4. Operation control#