Skip to content

api_client.api.BaseShipmentApi

Load the API package

import 'package:api_client/api.dart';

All URIs are relative to https://localhost

Method HTTP request Description
acceptShipment POST /acceptShipment
begin POST /begin
complete POST /complete
deleteShipment POST /deleteShipment
getShipment GET /getShipment
getShipments POST /getShipments
refreshPartners POST /refreshPartners
saveShipment POST /saveShipment
shipmentCancel POST /shipmentCancel
shipmentDecline POST /shipmentDecline
trackingSettings POST /trackingSettings

acceptShipment

ShipmentServiceModel acceptShipment(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new AcceptShipmentRequest(); // AcceptShipmentRequest | 

try { 
    var result = api_instance.acceptShipment(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->acceptShipment: $e\n");
}

Parameters

Name Type Description Notes
request AcceptShipmentRequest [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

begin

ShipmentServiceModel begin(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new BeginRequest(); // BeginRequest | 

try { 
    var result = api_instance.begin(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->begin: $e\n");
}

Parameters

Name Type Description Notes
request BeginRequest [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

complete

ShipmentServiceModel complete(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new CompleteRequest(); // CompleteRequest | 

try { 
    var result = api_instance.complete(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->complete: $e\n");
}

Parameters

Name Type Description Notes
request CompleteRequest [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteShipment

deleteShipment(id)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var id = id_example; // String | 

try { 
    api_instance.deleteShipment(id);
} catch (e) {
    print("Exception when calling BaseShipmentApi->deleteShipment: $e\n");
}

Parameters

Name Type Description Notes
id String [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getShipment

ShipmentServiceModel getShipment(id)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var id = id_example; // String | 

try { 
    var result = api_instance.getShipment(id);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->getShipment: $e\n");
}

Parameters

Name Type Description Notes
id String [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getShipments

QueryResultShipmentServiceModel getShipments(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new ShipmentQueryRequest(); // ShipmentQueryRequest | 

try { 
    var result = api_instance.getShipments(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->getShipments: $e\n");
}

Parameters

Name Type Description Notes
request ShipmentQueryRequest [optional]

Return type

QueryResultShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

refreshPartners

ShipmentServiceModel refreshPartners(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new RefreshPartnersRequest(); // RefreshPartnersRequest | 

try { 
    var result = api_instance.refreshPartners(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->refreshPartners: $e\n");
}

Parameters

Name Type Description Notes
request RefreshPartnersRequest [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

saveShipment

ShipmentServiceModel saveShipment(model)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var model = new ShipmentServiceModel(); // ShipmentServiceModel | 

try { 
    var result = api_instance.saveShipment(model);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->saveShipment: $e\n");
}

Parameters

Name Type Description Notes
model ShipmentServiceModel [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shipmentCancel

ShipmentServiceModel shipmentCancel(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new ShipmentCancelRequest(); // ShipmentCancelRequest | 

try { 
    var result = api_instance.shipmentCancel(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->shipmentCancel: $e\n");
}

Parameters

Name Type Description Notes
request ShipmentCancelRequest [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

shipmentDecline

ShipmentServiceModel shipmentDecline(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new ShipmentDeclineRequest(); // ShipmentDeclineRequest | 

try { 
    var result = api_instance.shipmentDecline(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->shipmentDecline: $e\n");
}

Parameters

Name Type Description Notes
request ShipmentDeclineRequest [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

trackingSettings

ShipmentServiceModel trackingSettings(request)

Example

import 'package:api_client/api.dart';

var api_instance = new BaseShipmentApi();
var request = new TrackingSettingsRequest(); // TrackingSettingsRequest | 

try { 
    var result = api_instance.trackingSettings(request);
    print(result);
} catch (e) {
    print("Exception when calling BaseShipmentApi->trackingSettings: $e\n");
}

Parameters

Name Type Description Notes
request TrackingSettingsRequest [optional]

Return type

ShipmentServiceModel

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json-patch+json, application/json, text/json, application/_*+json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]


Last update: July 4, 2020