ZHIPSTER CHECKOUT API V2

DROP OPTIONS

Zhipster Checkout is a stand-alone cloud application and can be used in combination with Zhipster Enterprise TA, Zhipster Control Tower TA or any other TA System on the market.

The Zhipster Checkout API provides an easy access to your shipping alternatives, or what we called them "Drop Options", based on your freight agreements and customer demands.

The concept of Drop Options is about offering one connection point, with a standardized delivery terminology. This, to create the opportunity to work with several different forwarder services and their related options without having the need to handle and manage all the actual differences, when it comes to Forwarder specific Web Services, service codes and other terminology.

‍

DECIDE WHICH DROP OPTIONS TO BE INCLUDED

Zhipster Checkout includes access to Zhipster Universal where the Group Admins can manage all Drop Rate Lists. Each Drop Rate List contains freight services from all the major (and some smaller) Freight Forwarders on the market. By activating different Drop Options in the Drop Rate List, these will be included in the API responses.

‍

It´s also possible to configure lead-times and prices and to use several Drop Rate Lists for different logistic conditions.

‍

DROP OPTIONS WORK FLOW

The Checkout API is based on a certain step-by-step work flow. The work flow is designed to work seamlessly with a web shop checkout process or directly with an ERP Order process.

‍

STEP BY STEP API PROCESS

The basic work flow of the API is as follows:

1. [GetDropOptions] - Post a Drop Option Request Message
2. [ConfirmDropOptions] - Post a Drop Option Confirmation Request Message
3. [UpdateDropConfiguration] - If you need to update the selected options or any other data
4. [DeleteDropConfiguration] - If you need to cancel the Drop Configuration
5. [GetDropConfiguration] - Get a Drop Configuration by using this method

REQUIREMENTS

To get responses including Drop Options, a Group Admin (Zhipster customer users) needs to configure one or several Drop Rate List in our Zhipster Universal Web UI.

‍

Use your existing LIVE/TEST API-Key's or contact developer@zhipster.se to apply for a new one.

Go to the API Pages below to start your work through our API documentation. If you have any questions, feel free to contact us at developer@zhipster.se

‍

API AUTHENTICATION

For authentication add your API-Key to [X-Api-Key] in HTTP Headers for all requests.

‍

GET DROP OPTIONS

GetDropOptions - Minimal - Request - Example.json

GetDropOptions - Minimal - Request - Example.xml

CONFIRM DROP OPTIONS

ConfirmDropOptions - Minimal - Request - Example.json

ConfirmDropOptions - Minimal - Request - Example.xml

UPDATE DROP CONFIGURATION

UpdateDropConfiguration - Minimal - Request - Example.json

UpdateDropConfiguration - Minimal - Request - Example.xml

VISUAL STUDIO 2022 .NET 5.0 TEST APPLICATION

Zhipster.Checkout.API.Test.zip

‍