Skip to content

ShippingApi.md

Latest commit

 

History

History
100 lines (63 loc) · 2.94 KB

ShippingApi.md

File metadata and controls

100 lines (63 loc) · 2.94 KB
Raw

ShippingApi

All URIs are relative to https://mgmtapi.geins.io

Method HTTP request Description
createParcelGroup POST /API/Shipping/ParcelGroup Create a new parcel group
queryShippingOptions POST /API/Shipping/Query Query shipping options

createParcelGroup

EnvelopeInt createParcelGroup(parcelGroupOptions)

Create a new parcel group

Example

// Import classes:
//import org.openapitools.client.api.ShippingApi;

ShippingApi apiInstance = new ShippingApi();
ShippingModelsParcelGroupOptions parcelGroupOptions = new ShippingModelsParcelGroupOptions(); // ShippingModelsParcelGroupOptions | Options for the new parcel group.
try {
    EnvelopeInt result = apiInstance.createParcelGroup(parcelGroupOptions);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ShippingApi#createParcelGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
parcelGroupOptions ShippingModelsParcelGroupOptions Options for the new parcel group.

Return type

EnvelopeInt

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml

queryShippingOptions

List<ShippingModelsShippingOption> queryShippingOptions(shippingQuery)

Query shipping options

No response envelope.

Example

// Import classes:
//import org.openapitools.client.api.ShippingApi;

ShippingApi apiInstance = new ShippingApi();
ShippingModelsShippingQuery shippingQuery = new ShippingModelsShippingQuery(); // ShippingModelsShippingQuery | The query to filter shipping options by.
try {
    List<ShippingModelsShippingOption> result = apiInstance.queryShippingOptions(shippingQuery);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ShippingApi#queryShippingOptions");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
shippingQuery ShippingModelsShippingQuery The query to filter shipping options by.

Return type

List<ShippingModelsShippingOption>

Authorization

apiKey, basicAuth

HTTP request headers

  • Content-Type: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
  • Accept: application/json, text/json, application/xml, text/xml