Associated Global Systems

DocumentRetrieval

GetDocument

Get a Particular Document.

API access URL. GET https://api1.agsystems.com/api/DocRetrieval/getDocument?docType=&fileExt=&GUID= docType : e.g. "INV" - Where Document Type is a descriptive code e.g. INV = Invoice. fileExt : e.g. "PDF"- file extension is a descriptive code of the file type. GUID : e.g. "b25b959554ed76058ac220b7b2e0a026" is GUID Key for document.


/api/DocumentRetrieval/getDocument

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/DocumentRetrieval/getDocument?docType=&fileExt=&GUID="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentRetrievalApi;

import java.io.File;
import java.util.*;

public class DocumentRetrievalApiExample {

    public static void main(String[] args) {
        
        DocumentRetrievalApi apiInstance = new DocumentRetrievalApi();
        String docType = docType_example; // String | Code for Document Type
        String fileExt = fileExt_example; // String | Code for Document Type
        String gUID = gUID_example; // String | GUID key for document
        try {
            Object result = apiInstance.documentRetrievalGetDocument(docType, fileExt, gUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentRetrievalApi#documentRetrievalGetDocument");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentRetrievalApi;

public class DocumentRetrievalApiExample {

    public static void main(String[] args) {
        DocumentRetrievalApi apiInstance = new DocumentRetrievalApi();
        String docType = docType_example; // String | Code for Document Type
        String fileExt = fileExt_example; // String | Code for Document Type
        String gUID = gUID_example; // String | GUID key for document
        try {
            Object result = apiInstance.documentRetrievalGetDocument(docType, fileExt, gUID);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentRetrievalApi#documentRetrievalGetDocument");
            e.printStackTrace();
        }
    }
}
String *docType = docType_example; // Code for Document Type
String *fileExt = fileExt_example; // Code for Document Type
String *gUID = gUID_example; // GUID key for document

DocumentRetrievalApi *apiInstance = [[DocumentRetrievalApi alloc] init];

// Get a Particular Document.
[apiInstance documentRetrievalGetDocumentWith:docType
    fileExt:fileExt
    gUID:gUID
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.DocumentRetrievalApi()

var docType = docType_example; // {String} Code for Document Type

var fileExt = fileExt_example; // {String} Code for Document Type

var gUID = gUID_example; // {String} GUID key for document


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentRetrievalGetDocument(docType, fileExt, gUID, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class documentRetrievalGetDocumentExample
    {
        public void main()
        {
            
            var apiInstance = new DocumentRetrievalApi();
            var docType = docType_example;  // String | Code for Document Type
            var fileExt = fileExt_example;  // String | Code for Document Type
            var gUID = gUID_example;  // String | GUID key for document

            try
            {
                // Get a Particular Document.
                Object result = apiInstance.documentRetrievalGetDocument(docType, fileExt, gUID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentRetrievalApi.documentRetrievalGetDocument: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DocumentRetrievalApi();
$docType = docType_example; // String | Code for Document Type
$fileExt = fileExt_example; // String | Code for Document Type
$gUID = gUID_example; // String | GUID key for document

try {
    $result = $api_instance->documentRetrievalGetDocument($docType, $fileExt, $gUID);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentRetrievalApi->documentRetrievalGetDocument: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentRetrievalApi;

my $api_instance = WWW::SwaggerClient::DocumentRetrievalApi->new();
my $docType = docType_example; # String | Code for Document Type
my $fileExt = fileExt_example; # String | Code for Document Type
my $gUID = gUID_example; # String | GUID key for document

eval { 
    my $result = $api_instance->documentRetrievalGetDocument(docType => $docType, fileExt => $fileExt, gUID => $gUID);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentRetrievalApi->documentRetrievalGetDocument: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentRetrievalApi()
docType = docType_example # String | Code for Document Type
fileExt = fileExt_example # String | Code for Document Type
gUID = gUID_example # String | GUID key for document

try: 
    # Get a Particular Document.
    api_response = api_instance.document_retrieval_get_document(docType, fileExt, gUID)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentRetrievalApi->documentRetrievalGetDocument: %s\n" % e)

Parameters

Query parameters
Name Description
docType*
String
Code for Document Type
Required
fileExt*
String
Code for Document Type
Required
GUID*
String
GUID key for document
Required

Responses

Status: 200 - Returns the JSON SchedulerAppointment Object.

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - Document was NOT FOUND


GetDocumentURLS

Get Document URLs by Shipment ID.

API access URL. GET https://api1.agsystems.com/api/DocRetrieval/getDocumentURLs?shipmentId=&amp;apiKey= shipmentId : "1234567" - Where shipmentId is a 7 digit integer. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/DocumentRetrieval/getDocumentURLS

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/DocumentRetrieval/getDocumentURLS?shipmentId=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DocumentRetrievalApi;

import java.io.File;
import java.util.*;

public class DocumentRetrievalApiExample {

    public static void main(String[] args) {
        
        DocumentRetrievalApi apiInstance = new DocumentRetrievalApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            Object result = apiInstance.documentRetrievalGetDocumentURLS(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentRetrievalApi#documentRetrievalGetDocumentURLS");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DocumentRetrievalApi;

public class DocumentRetrievalApiExample {

    public static void main(String[] args) {
        DocumentRetrievalApi apiInstance = new DocumentRetrievalApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            Object result = apiInstance.documentRetrievalGetDocumentURLS(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DocumentRetrievalApi#documentRetrievalGetDocumentURLS");
            e.printStackTrace();
        }
    }
}
String *shipmentId = shipmentId_example; // Shipment Id Number
String *apiKey = apiKey_example; // AGS - API Key

DocumentRetrievalApi *apiInstance = [[DocumentRetrievalApi alloc] init];

// Get Document URLs by Shipment ID.
[apiInstance documentRetrievalGetDocumentURLSWith:shipmentId
    apiKey:apiKey
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.DocumentRetrievalApi()

var shipmentId = shipmentId_example; // {String} Shipment Id Number

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.documentRetrievalGetDocumentURLS(shipmentId, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class documentRetrievalGetDocumentURLSExample
    {
        public void main()
        {
            
            var apiInstance = new DocumentRetrievalApi();
            var shipmentId = shipmentId_example;  // String | Shipment Id Number
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get Document URLs by Shipment ID.
                Object result = apiInstance.documentRetrievalGetDocumentURLS(shipmentId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentRetrievalApi.documentRetrievalGetDocumentURLS: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\DocumentRetrievalApi();
$shipmentId = shipmentId_example; // String | Shipment Id Number
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->documentRetrievalGetDocumentURLS($shipmentId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DocumentRetrievalApi->documentRetrievalGetDocumentURLS: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DocumentRetrievalApi;

my $api_instance = WWW::SwaggerClient::DocumentRetrievalApi->new();
my $shipmentId = shipmentId_example; # String | Shipment Id Number
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->documentRetrievalGetDocumentURLS(shipmentId => $shipmentId, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DocumentRetrievalApi->documentRetrievalGetDocumentURLS: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.DocumentRetrievalApi()
shipmentId = shipmentId_example # String | Shipment Id Number
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get Document URLs by Shipment ID.
    api_response = api_instance.document_retrieval_get_document_urls(shipmentId, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DocumentRetrievalApi->documentRetrievalGetDocumentURLS: %s\n" % e)

Parameters

Query parameters
Name Description
shipmentId*
String
Shipment Id Number
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - Returns the List of Document URLs.

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - Documents were NOT FOUND


Quote

ActivateQuote

Activates an AGS Quote.

API access URL to Activate a returned Quote by providing the minimum required parameters within the body of the POST request. POST https://api1.agsystems.com/api/Quote/ActivateQuote


/api/Quote/ActivateQuote

Usage and SDK Samples

curl -X POST "http://localhost:62684/api/Quote/ActivateQuote"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuoteApi;

import java.io.File;
import java.util.*;

public class QuoteApiExample {

    public static void main(String[] args) {
        
        QuoteApi apiInstance = new QuoteApi();
        QuoteInfo quoteInfo = ; // QuoteInfo | 
        try {
            array[QuoteInfo] result = apiInstance.quoteActivateQuote(quoteInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteActivateQuote");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuoteApi;

public class QuoteApiExample {

    public static void main(String[] args) {
        QuoteApi apiInstance = new QuoteApi();
        QuoteInfo quoteInfo = ; // QuoteInfo | 
        try {
            array[QuoteInfo] result = apiInstance.quoteActivateQuote(quoteInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteActivateQuote");
            e.printStackTrace();
        }
    }
}
QuoteInfo *quoteInfo = ; // 

QuoteApi *apiInstance = [[QuoteApi alloc] init];

// Activates an AGS Quote.
[apiInstance quoteActivateQuoteWith:quoteInfo
              completionHandler: ^(array[QuoteInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.QuoteApi()

var quoteInfo = ; // {QuoteInfo} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.quoteActivateQuote(quoteInfo, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quoteActivateQuoteExample
    {
        public void main()
        {
            
            var apiInstance = new QuoteApi();
            var quoteInfo = new QuoteInfo(); // QuoteInfo | 

            try
            {
                // Activates an AGS Quote.
                array[QuoteInfo] result = apiInstance.quoteActivateQuote(quoteInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuoteApi.quoteActivateQuote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuoteApi();
$quoteInfo = ; // QuoteInfo | 

try {
    $result = $api_instance->quoteActivateQuote($quoteInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuoteApi->quoteActivateQuote: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuoteApi;

my $api_instance = WWW::SwaggerClient::QuoteApi->new();
my $quoteInfo = WWW::SwaggerClient::Object::QuoteInfo->new(); # QuoteInfo | 

eval { 
    my $result = $api_instance->quoteActivateQuote(quoteInfo => $quoteInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuoteApi->quoteActivateQuote: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuoteApi()
quoteInfo =  # QuoteInfo | 

try: 
    # Activates an AGS Quote.
    api_response = api_instance.quote_activate_quote(quoteInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuoteApi->quoteActivateQuote: %s\n" % e)

Parameters

Body parameters
Name Description
quoteInfo *

Responses

Status: 200 - OK

{headerData={apikey=null, billtonumber=0, housenumber=0, quoteno=0, shipmentid=0, activatestatus=false, message=null}, originatorInfo={name=null, phone=null, email=null}, activatorInfo={name=null, phone=null, email=null}, shipperInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, shipperreference=null}, shipperReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, consigneeInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, consigneereference=null}, consigneeReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, serviceInfo={service=null, readydate=null, readytime=0, closetime=0, declaredvalue=0}, pieceInfo={totalpieces=0, totalweight=0, pieces=[]}, partsInfo=[], specialInstructions={specialinstructionS1=null, specialinstructionS2=null, specialinstructionS3=null, specialinstructionS4=null, specialinstructionS5=null}, tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}, additionalCharges={chargE1=null, chargE2=null, chargE3=null, chargE4=null, chargE5=null, chargE6=null, chargE7=null, chargE8=null, chargE9=null, chargE10=null}, quoteCharges={totalcharges=null, charges=[]}}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response


CreateQuote

Create an AGS Quote.

API access URL to Activate a returned Quote by providing the minimum required parameters within the body of the POST request. POST https://api1.agsystems.com/api/Quote/createQuote


/api/Quote/CreateQuote

Usage and SDK Samples

curl -X POST "http://localhost:62684/api/Quote/CreateQuote"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuoteApi;

import java.io.File;
import java.util.*;

public class QuoteApiExample {

    public static void main(String[] args) {
        
        QuoteApi apiInstance = new QuoteApi();
        QuoteInfo quoteInfo = ; // QuoteInfo | 
        try {
            array[QuoteInfo] result = apiInstance.quoteCreateQuote(quoteInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteCreateQuote");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuoteApi;

public class QuoteApiExample {

    public static void main(String[] args) {
        QuoteApi apiInstance = new QuoteApi();
        QuoteInfo quoteInfo = ; // QuoteInfo | 
        try {
            array[QuoteInfo] result = apiInstance.quoteCreateQuote(quoteInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteCreateQuote");
            e.printStackTrace();
        }
    }
}
QuoteInfo *quoteInfo = ; // 

QuoteApi *apiInstance = [[QuoteApi alloc] init];

// Create an AGS Quote.
[apiInstance quoteCreateQuoteWith:quoteInfo
              completionHandler: ^(array[QuoteInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.QuoteApi()

var quoteInfo = ; // {QuoteInfo} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.quoteCreateQuote(quoteInfo, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quoteCreateQuoteExample
    {
        public void main()
        {
            
            var apiInstance = new QuoteApi();
            var quoteInfo = new QuoteInfo(); // QuoteInfo | 

            try
            {
                // Create an AGS Quote.
                array[QuoteInfo] result = apiInstance.quoteCreateQuote(quoteInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuoteApi.quoteCreateQuote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuoteApi();
$quoteInfo = ; // QuoteInfo | 

try {
    $result = $api_instance->quoteCreateQuote($quoteInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuoteApi->quoteCreateQuote: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuoteApi;

my $api_instance = WWW::SwaggerClient::QuoteApi->new();
my $quoteInfo = WWW::SwaggerClient::Object::QuoteInfo->new(); # QuoteInfo | 

eval { 
    my $result = $api_instance->quoteCreateQuote(quoteInfo => $quoteInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuoteApi->quoteCreateQuote: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuoteApi()
quoteInfo =  # QuoteInfo | 

try: 
    # Create an AGS Quote.
    api_response = api_instance.quote_create_quote(quoteInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuoteApi->quoteCreateQuote: %s\n" % e)

Parameters

Body parameters
Name Description
quoteInfo *

Responses

Status: 200 - OK

{headerData={apikey=null, billtonumber=0, housenumber=0, quoteno=0, shipmentid=0, activatestatus=false, message=null}, originatorInfo={name=null, phone=null, email=null}, activatorInfo={name=null, phone=null, email=null}, shipperInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, shipperreference=null}, shipperReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, consigneeInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, consigneereference=null}, consigneeReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, serviceInfo={service=null, readydate=null, readytime=0, closetime=0, declaredvalue=0}, pieceInfo={totalpieces=0, totalweight=0, pieces=[]}, partsInfo=[], specialInstructions={specialinstructionS1=null, specialinstructionS2=null, specialinstructionS3=null, specialinstructionS4=null, specialinstructionS5=null}, tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}, additionalCharges={chargE1=null, chargE2=null, chargE3=null, chargE4=null, chargE5=null, chargE6=null, chargE7=null, chargE8=null, chargE9=null, chargE10=null}, quoteCharges={totalcharges=null, charges=[]}}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response


GetDefaultServices

Retrieve Default Charge Services assigned to the APIKEY.

API access URL to retrieve default services assigned to the provided APIKEY GET https://api1.agsystems.com/api/Quote/GetDefaultServices?apiKey= apikey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Quote/GetDefaultServices

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Quote/GetDefaultServices?apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuoteApi;

import java.io.File;
import java.util.*;

public class QuoteApiExample {

    public static void main(String[] args) {
        
        QuoteApi apiInstance = new QuoteApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[BillTos] result = apiInstance.quoteGetDefaultServices(apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteGetDefaultServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuoteApi;

public class QuoteApiExample {

    public static void main(String[] args) {
        QuoteApi apiInstance = new QuoteApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[BillTos] result = apiInstance.quoteGetDefaultServices(apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteGetDefaultServices");
            e.printStackTrace();
        }
    }
}
String *apiKey = apiKey_example; // AGS - API Key

QuoteApi *apiInstance = [[QuoteApi alloc] init];

// Retrieve Default Charge Services assigned to the APIKEY.
[apiInstance quoteGetDefaultServicesWith:apiKey
              completionHandler: ^(array[BillTos] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.QuoteApi()

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.quoteGetDefaultServices(apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quoteGetDefaultServicesExample
    {
        public void main()
        {
            
            var apiInstance = new QuoteApi();
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Retrieve Default Charge Services assigned to the APIKEY.
                array[BillTos] result = apiInstance.quoteGetDefaultServices(apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuoteApi.quoteGetDefaultServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuoteApi();
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->quoteGetDefaultServices($apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuoteApi->quoteGetDefaultServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuoteApi;

my $api_instance = WWW::SwaggerClient::QuoteApi->new();
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->quoteGetDefaultServices(apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuoteApi->quoteGetDefaultServices: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuoteApi()
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Retrieve Default Charge Services assigned to the APIKEY.
    api_response = api_instance.quote_get_default_services(apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuoteApi->quoteGetDefaultServices: %s\n" % e)

Parameters

Query parameters
Name Description
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

{key=null, id=0, billTo=0, services=[], accessorials=[]}

Status: 404 - The Services are NOT FOUND


GetQuote

Retrieve a Quote Created but not Activated.

API access URL to retrieve a generated quote. GET https://api1.agsystems.com/api/Quote/GetQuote?quoteId=&amp;apiKey= quoteId: "1234567" - Where quote ID is a 7 digit integer. apikey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Quote/GetQuote

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Quote/GetQuote?apiKey="eId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.QuoteApi;

import java.io.File;
import java.util.*;

public class QuoteApiExample {

    public static void main(String[] args) {
        
        QuoteApi apiInstance = new QuoteApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        Long quoteId = 789; // Long | Previously Generated Quote Id
        try {
            array[QuoteInfo] result = apiInstance.quoteGetQuote(apiKey, quoteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteGetQuote");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.QuoteApi;

public class QuoteApiExample {

    public static void main(String[] args) {
        QuoteApi apiInstance = new QuoteApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        Long quoteId = 789; // Long | Previously Generated Quote Id
        try {
            array[QuoteInfo] result = apiInstance.quoteGetQuote(apiKey, quoteId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling QuoteApi#quoteGetQuote");
            e.printStackTrace();
        }
    }
}
String *apiKey = apiKey_example; // AGS - API Key
Long *quoteId = 789; // Previously Generated Quote Id

QuoteApi *apiInstance = [[QuoteApi alloc] init];

// Retrieve a Quote Created but not Activated.
[apiInstance quoteGetQuoteWith:apiKey
    quoteId:quoteId
              completionHandler: ^(array[QuoteInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.QuoteApi()

var apiKey = apiKey_example; // {String} AGS - API Key

var quoteId = 789; // {Long} Previously Generated Quote Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.quoteGetQuote(apiKey, quoteId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class quoteGetQuoteExample
    {
        public void main()
        {
            
            var apiInstance = new QuoteApi();
            var apiKey = apiKey_example;  // String | AGS - API Key
            var quoteId = 789;  // Long | Previously Generated Quote Id

            try
            {
                // Retrieve a Quote Created but not Activated.
                array[QuoteInfo] result = apiInstance.quoteGetQuote(apiKey, quoteId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling QuoteApi.quoteGetQuote: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\QuoteApi();
$apiKey = apiKey_example; // String | AGS - API Key
$quoteId = 789; // Long | Previously Generated Quote Id

try {
    $result = $api_instance->quoteGetQuote($apiKey, $quoteId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuoteApi->quoteGetQuote: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::QuoteApi;

my $api_instance = WWW::SwaggerClient::QuoteApi->new();
my $apiKey = apiKey_example; # String | AGS - API Key
my $quoteId = 789; # Long | Previously Generated Quote Id

eval { 
    my $result = $api_instance->quoteGetQuote(apiKey => $apiKey, quoteId => $quoteId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling QuoteApi->quoteGetQuote: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.QuoteApi()
apiKey = apiKey_example # String | AGS - API Key
quoteId = 789 # Long | Previously Generated Quote Id

try: 
    # Retrieve a Quote Created but not Activated.
    api_response = api_instance.quote_get_quote(apiKey, quoteId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling QuoteApi->quoteGetQuote: %s\n" % e)

Parameters

Query parameters
Name Description
apiKey*
String
AGS - API Key
Required
quoteId*
Long (int64)
Previously Generated Quote Id
Required

Responses

Status: 200 - OK

{headerData={apikey=null, billtonumber=0, housenumber=0, quoteno=0, shipmentid=0, activatestatus=false, message=null}, originatorInfo={name=null, phone=null, email=null}, activatorInfo={name=null, phone=null, email=null}, shipperInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, shipperreference=null}, shipperReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, consigneeInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, consigneereference=null}, consigneeReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, serviceInfo={service=null, readydate=null, readytime=0, closetime=0, declaredvalue=0}, pieceInfo={totalpieces=0, totalweight=0, pieces=[]}, partsInfo=[], specialInstructions={specialinstructionS1=null, specialinstructionS2=null, specialinstructionS3=null, specialinstructionS4=null, specialinstructionS5=null}, tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}, additionalCharges={chargE1=null, chargE2=null, chargE3=null, chargE4=null, chargE5=null, chargE6=null, chargE7=null, chargE8=null, chargE9=null, chargE10=null}, quoteCharges={totalcharges=null, charges=[]}}

Status: 404 - The Quote is NOT FOUND


Scheduler

GetAppointmentInfo

Retrieve Appointment Schedule Information using Consignee Reference and Destination ZipCode.

API access URL. GET https://api1.agsystems.com/api/Scheduler/getAppointmentInfo?consigneeRef=&amp;zipCode=&amp;apiKey= consigneeRef : "XXXXXXX" - Where consigneeRef is provided. zipCode : "12345" - Where zipCode is the destination ZipCode. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Scheduler/getAppointmentInfo

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Scheduler/getAppointmentInfo?consigneeRef=&zipCode=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        String consigneeRef = consigneeRef_example; // String | Consignee Reference
        String zipCode = zipCode_example; // String | Delivery Destination ZipCode
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            SchedulerShipment result = apiInstance.schedulerGetAppointmentInfo(consigneeRef, zipCode, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetAppointmentInfo");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        String consigneeRef = consigneeRef_example; // String | Consignee Reference
        String zipCode = zipCode_example; // String | Delivery Destination ZipCode
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            SchedulerShipment result = apiInstance.schedulerGetAppointmentInfo(consigneeRef, zipCode, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetAppointmentInfo");
            e.printStackTrace();
        }
    }
}
String *consigneeRef = consigneeRef_example; // Consignee Reference
String *zipCode = zipCode_example; // Delivery Destination ZipCode
String *apiKey = apiKey_example; // AGS - API Key

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Retrieve Appointment Schedule Information using Consignee Reference and Destination ZipCode.
[apiInstance schedulerGetAppointmentInfoWith:consigneeRef
    zipCode:zipCode
    apiKey:apiKey
              completionHandler: ^(SchedulerShipment output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var consigneeRef = consigneeRef_example; // {String} Consignee Reference

var zipCode = zipCode_example; // {String} Delivery Destination ZipCode

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerGetAppointmentInfo(consigneeRef, zipCode, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerGetAppointmentInfoExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var consigneeRef = consigneeRef_example;  // String | Consignee Reference
            var zipCode = zipCode_example;  // String | Delivery Destination ZipCode
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Retrieve Appointment Schedule Information using Consignee Reference and Destination ZipCode.
                SchedulerShipment result = apiInstance.schedulerGetAppointmentInfo(consigneeRef, zipCode, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerGetAppointmentInfo: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$consigneeRef = consigneeRef_example; // String | Consignee Reference
$zipCode = zipCode_example; // String | Delivery Destination ZipCode
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->schedulerGetAppointmentInfo($consigneeRef, $zipCode, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerGetAppointmentInfo: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $consigneeRef = consigneeRef_example; # String | Consignee Reference
my $zipCode = zipCode_example; # String | Delivery Destination ZipCode
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->schedulerGetAppointmentInfo(consigneeRef => $consigneeRef, zipCode => $zipCode, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerGetAppointmentInfo: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
consigneeRef = consigneeRef_example # String | Consignee Reference
zipCode = zipCode_example # String | Delivery Destination ZipCode
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Retrieve Appointment Schedule Information using Consignee Reference and Destination ZipCode.
    api_response = api_instance.scheduler_get_appointment_info(consigneeRef, zipCode, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerGetAppointmentInfo: %s\n" % e)

Parameters

Query parameters
Name Description
consigneeRef*
String
Consignee Reference
Required
zipCode*
String
Delivery Destination ZipCode
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

{msgFlag=null, destinationAirport=null, destinationArea=null, houseAirWayBillNumber=null, originAirport=null, originArea=null, shipmentId=null, houseService=null, readyDate=0001-01-01T00:00:00, pieces=[], parts=[], parties=[], expenses=[]}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - The Shipment was NOT FOUND


GetDefaultSchedulerAppointment

Get a Default Scheduler Appointment. (APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)

API access URL. GET https://api1.agsystems.com/api/Scheduler/getDefaultSchedulerAppointment?shipmentId=&amp;zipCode=&amp;apiKey= shipmentId : "1234567" - Where shipmentId is a 7 digit integer. zipCode : "12345" - Where zipCode is the destination ZipCode. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Scheduler/getDefaultSchedulerAppointment

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Scheduler/getDefaultSchedulerAppointment?shipmentId=&zipCode=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String zipCode = zipCode_example; // String | Delivery Destination ZipCode
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerAppointment] result = apiInstance.schedulerGetDefaultSchedulerAppointment(shipmentId, zipCode, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetDefaultSchedulerAppointment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String zipCode = zipCode_example; // String | Delivery Destination ZipCode
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerAppointment] result = apiInstance.schedulerGetDefaultSchedulerAppointment(shipmentId, zipCode, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetDefaultSchedulerAppointment");
            e.printStackTrace();
        }
    }
}
String *shipmentId = shipmentId_example; // Shipment Id Number
String *zipCode = zipCode_example; // Delivery Destination ZipCode
String *apiKey = apiKey_example; // AGS - API Key

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Get a Default Scheduler Appointment. 
(APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)
[apiInstance schedulerGetDefaultSchedulerAppointmentWith:shipmentId
    zipCode:zipCode
    apiKey:apiKey
              completionHandler: ^(array[SchedulerAppointment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var shipmentId = shipmentId_example; // {String} Shipment Id Number

var zipCode = zipCode_example; // {String} Delivery Destination ZipCode

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerGetDefaultSchedulerAppointment(shipmentId, zipCode, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerGetDefaultSchedulerAppointmentExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var shipmentId = shipmentId_example;  // String | Shipment Id Number
            var zipCode = zipCode_example;  // String | Delivery Destination ZipCode
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get a Default Scheduler Appointment. 
(APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)
                array[SchedulerAppointment] result = apiInstance.schedulerGetDefaultSchedulerAppointment(shipmentId, zipCode, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerGetDefaultSchedulerAppointment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$shipmentId = shipmentId_example; // String | Shipment Id Number
$zipCode = zipCode_example; // String | Delivery Destination ZipCode
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->schedulerGetDefaultSchedulerAppointment($shipmentId, $zipCode, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerGetDefaultSchedulerAppointment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $shipmentId = shipmentId_example; # String | Shipment Id Number
my $zipCode = zipCode_example; # String | Delivery Destination ZipCode
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->schedulerGetDefaultSchedulerAppointment(shipmentId => $shipmentId, zipCode => $zipCode, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerGetDefaultSchedulerAppointment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
shipmentId = shipmentId_example # String | Shipment Id Number
zipCode = zipCode_example # String | Delivery Destination ZipCode
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get a Default Scheduler Appointment. 
(APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)
    api_response = api_instance.scheduler_get_default_scheduler_appointment(shipmentId, zipCode, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerGetDefaultSchedulerAppointment: %s\n" % e)

Parameters

Query parameters
Name Description
shipmentId*
String
Shipment Id Number
Required
zipCode*
String
Delivery Destination ZipCode
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{date=2017-09-01T00:00:00, timeSlotCode=T1, dateString=null}]

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - The Default Scheduler Appointment was NOT FOUND


ScheduledContactInformation

Get Previously Scheduled Contact Information.

API access URL. GET https://api1.agsystems.com/api/Scheduler/getScheduledContactInformation?shipmentId&amp;apiKey= shipmentId : "1234567" - Where shipmentId is a 7 digit integer. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Scheduler/getScheduledContactInformation

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Scheduler/getScheduledContactInformation?shipmentId=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerContactInfo] result = apiInstance.schedulerGetScheduledContactInformation(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetScheduledContactInformation");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerContactInfo] result = apiInstance.schedulerGetScheduledContactInformation(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetScheduledContactInformation");
            e.printStackTrace();
        }
    }
}
String *shipmentId = shipmentId_example; // Shipment Id Number
String *apiKey = apiKey_example; // AGS - API Key

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Get Previously Scheduled Contact Information.
[apiInstance schedulerGetScheduledContactInformationWith:shipmentId
    apiKey:apiKey
              completionHandler: ^(array[SchedulerContactInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var shipmentId = shipmentId_example; // {String} Shipment Id Number

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerGetScheduledContactInformation(shipmentId, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerGetScheduledContactInformationExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var shipmentId = shipmentId_example;  // String | Shipment Id Number
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get Previously Scheduled Contact Information.
                array[SchedulerContactInfo] result = apiInstance.schedulerGetScheduledContactInformation(shipmentId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerGetScheduledContactInformation: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$shipmentId = shipmentId_example; // String | Shipment Id Number
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->schedulerGetScheduledContactInformation($shipmentId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerGetScheduledContactInformation: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $shipmentId = shipmentId_example; # String | Shipment Id Number
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->schedulerGetScheduledContactInformation(shipmentId => $shipmentId, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerGetScheduledContactInformation: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
shipmentId = shipmentId_example # String | Shipment Id Number
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get Previously Scheduled Contact Information.
    api_response = api_instance.scheduler_get_scheduled_contact_information(shipmentId, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerGetScheduledContactInformation: %s\n" % e)

Parameters

Query parameters
Name Description
shipmentId*
String
Shipment Id Number
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

{contactName=John Smith, contactEmail=johnsmith@agsystems.com, contactPhone=312 555 5555, specialInstructions=Please leave with door man, services=[{deliveryServiceCode=UFE}, {deliveryServiceCode=SC}]}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - The Contact Information was NOT FOUND


GetScheduledDeliveryAppointment

Get a Scheduled Delivery Appointment.

API access URL. GET https://api1.agsystems.com/api/Scheduler/getScheduledDeliveryAppointment?shipmentId&amp;apiKey= shipmentId : "1234567" - Where shipmentId is a 7 digit integer. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Scheduler/getScheduledDeliveryAppointment

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Scheduler/getScheduledDeliveryAppointment?shipmentId=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ScheduledAppointment] result = apiInstance.schedulerGetScheduledDeliveryAppointment(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetScheduledDeliveryAppointment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ScheduledAppointment] result = apiInstance.schedulerGetScheduledDeliveryAppointment(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetScheduledDeliveryAppointment");
            e.printStackTrace();
        }
    }
}
String *shipmentId = shipmentId_example; // Shipment Id Number
String *apiKey = apiKey_example; // AGS - API Key

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Get a Scheduled Delivery Appointment.
[apiInstance schedulerGetScheduledDeliveryAppointmentWith:shipmentId
    apiKey:apiKey
              completionHandler: ^(array[ScheduledAppointment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var shipmentId = shipmentId_example; // {String} Shipment Id Number

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerGetScheduledDeliveryAppointment(shipmentId, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerGetScheduledDeliveryAppointmentExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var shipmentId = shipmentId_example;  // String | Shipment Id Number
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get a Scheduled Delivery Appointment.
                array[ScheduledAppointment] result = apiInstance.schedulerGetScheduledDeliveryAppointment(shipmentId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerGetScheduledDeliveryAppointment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$shipmentId = shipmentId_example; // String | Shipment Id Number
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->schedulerGetScheduledDeliveryAppointment($shipmentId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerGetScheduledDeliveryAppointment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $shipmentId = shipmentId_example; # String | Shipment Id Number
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->schedulerGetScheduledDeliveryAppointment(shipmentId => $shipmentId, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerGetScheduledDeliveryAppointment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
shipmentId = shipmentId_example # String | Shipment Id Number
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get a Scheduled Delivery Appointment.
    api_response = api_instance.scheduler_get_scheduled_delivery_appointment(shipmentId, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerGetScheduledDeliveryAppointment: %s\n" % e)

Parameters

Query parameters
Name Description
shipmentId*
String
Shipment Id Number
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

{date=2017-09-01T00:00:00, timeSlot=9:00 a.m. - 1:00 p.m., rescheduleAllowed=YES, rescheduledMessage=null}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - The Scheduled Delivery Appointment was NOT FOUND


GetSchedulerAppointments

Get Alternative Scheduler Appointments. (APPOINTMENTS EXPIRE 15 MINUTES AFTER RESPONSE)

API access URL. GET https://api1.agsystems.com/api/Scheduler/getSchedulerAppointments?shipmentId=&amp;zipCode=&amp;fromDate=&amp;toDate=&amp;apiKey= shipmentId : "1234567" - Where shipmentId is a 7 digit integer. zipCode : "12345" - Where zipCode is the destination ZipCode. fromDate : "20170822" - Where fromDate is the start search Date. toDate : "20170823" - Where fromDate is the end search Date. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Scheduler/getSchedulerAppointments

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Scheduler/getSchedulerAppointments?shipmentId=&zipCode=&fromDate=&toDate=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String zipCode = zipCode_example; // String | Delivery Destination ZipCode
        String fromDate = fromDate_example; // String | Date to start search
        String toDate = toDate_example; // String | Date to end search
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerAppointment] result = apiInstance.schedulerGetSchedulerAppointments(shipmentId, zipCode, fromDate, toDate, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetSchedulerAppointments");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String zipCode = zipCode_example; // String | Delivery Destination ZipCode
        String fromDate = fromDate_example; // String | Date to start search
        String toDate = toDate_example; // String | Date to end search
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerAppointment] result = apiInstance.schedulerGetSchedulerAppointments(shipmentId, zipCode, fromDate, toDate, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetSchedulerAppointments");
            e.printStackTrace();
        }
    }
}
String *shipmentId = shipmentId_example; // Shipment Id Number
String *zipCode = zipCode_example; // Delivery Destination ZipCode
String *fromDate = fromDate_example; // Date to start search
String *toDate = toDate_example; // Date to end search
String *apiKey = apiKey_example; // AGS - API Key

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Get Alternative Scheduler Appointments. 
(APPOINTMENTS EXPIRE 15 MINUTES AFTER RESPONSE)
[apiInstance schedulerGetSchedulerAppointmentsWith:shipmentId
    zipCode:zipCode
    fromDate:fromDate
    toDate:toDate
    apiKey:apiKey
              completionHandler: ^(array[SchedulerAppointment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var shipmentId = shipmentId_example; // {String} Shipment Id Number

var zipCode = zipCode_example; // {String} Delivery Destination ZipCode

var fromDate = fromDate_example; // {String} Date to start search

var toDate = toDate_example; // {String} Date to end search

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerGetSchedulerAppointments(shipmentId, zipCode, fromDate, toDate, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerGetSchedulerAppointmentsExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var shipmentId = shipmentId_example;  // String | Shipment Id Number
            var zipCode = zipCode_example;  // String | Delivery Destination ZipCode
            var fromDate = fromDate_example;  // String | Date to start search
            var toDate = toDate_example;  // String | Date to end search
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get Alternative Scheduler Appointments. 
(APPOINTMENTS EXPIRE 15 MINUTES AFTER RESPONSE)
                array[SchedulerAppointment] result = apiInstance.schedulerGetSchedulerAppointments(shipmentId, zipCode, fromDate, toDate, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerGetSchedulerAppointments: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$shipmentId = shipmentId_example; // String | Shipment Id Number
$zipCode = zipCode_example; // String | Delivery Destination ZipCode
$fromDate = fromDate_example; // String | Date to start search
$toDate = toDate_example; // String | Date to end search
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->schedulerGetSchedulerAppointments($shipmentId, $zipCode, $fromDate, $toDate, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerGetSchedulerAppointments: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $shipmentId = shipmentId_example; # String | Shipment Id Number
my $zipCode = zipCode_example; # String | Delivery Destination ZipCode
my $fromDate = fromDate_example; # String | Date to start search
my $toDate = toDate_example; # String | Date to end search
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->schedulerGetSchedulerAppointments(shipmentId => $shipmentId, zipCode => $zipCode, fromDate => $fromDate, toDate => $toDate, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerGetSchedulerAppointments: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
shipmentId = shipmentId_example # String | Shipment Id Number
zipCode = zipCode_example # String | Delivery Destination ZipCode
fromDate = fromDate_example # String | Date to start search
toDate = toDate_example # String | Date to end search
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get Alternative Scheduler Appointments. 
(APPOINTMENTS EXPIRE 15 MINUTES AFTER RESPONSE)
    api_response = api_instance.scheduler_get_scheduler_appointments(shipmentId, zipCode, fromDate, toDate, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerGetSchedulerAppointments: %s\n" % e)

Parameters

Query parameters
Name Description
shipmentId*
String
Shipment Id Number
Required
zipCode*
String
Delivery Destination ZipCode
Required
fromDate*
String
Date to start search
Required
toDate*
String
Date to end search
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{date=2017-09-01T00:00:00, timeSlotCode=T1, dateString=null}]

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - The Scheduler Appointments were NOT FOUND


GetSchedulerDefaults

Get Delivery Service Options and Time Slot Description Information.

API access URL. GET https://api1.agsystems.com/api/Scheduler/getSchedulerDefaults?apiKey= apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Scheduler/getSchedulerDefaults

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Scheduler/getSchedulerDefaults?apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerDefault] result = apiInstance.schedulerGetSchedulerDefaults(apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetSchedulerDefaults");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[SchedulerDefault] result = apiInstance.schedulerGetSchedulerDefaults(apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetSchedulerDefaults");
            e.printStackTrace();
        }
    }
}
String *apiKey = apiKey_example; // AGS - API Key

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Get Delivery Service Options and Time Slot Description Information.
[apiInstance schedulerGetSchedulerDefaultsWith:apiKey
              completionHandler: ^(array[SchedulerDefault] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerGetSchedulerDefaults(apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerGetSchedulerDefaultsExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get Delivery Service Options and Time Slot Description Information.
                array[SchedulerDefault] result = apiInstance.schedulerGetSchedulerDefaults(apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerGetSchedulerDefaults: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->schedulerGetSchedulerDefaults($apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerGetSchedulerDefaults: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->schedulerGetSchedulerDefaults(apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerGetSchedulerDefaults: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get Delivery Service Options and Time Slot Description Information.
    api_response = api_instance.scheduler_get_scheduler_defaults(apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerGetSchedulerDefaults: %s\n" % e)

Parameters

Query parameters
Name Description
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

{deliveryServiceOptions=[], timeSlots=[]}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - The Scheduler Default information was NOT FOUND


GetshipmentByShipmentIdByAPIID

Get a Shipment by ShipmentId by API ID. (APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)

API access URL. GET https://api1.agsystems.com/api/Scheduler/getshipmentByShipmentIdByAPIID?ShipmentId=&amp;apiKey= shipmentId : "1234567" - Where shipmentId is a 7 digit integer. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Scheduler/getshipmentByShipmentIdByAPIID

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Scheduler/getshipmentByShipmentIdByAPIID?shipmentId=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentInfo] result = apiInstance.schedulerGetshipmentByShipmentIdByAPIID(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetshipmentByShipmentIdByAPIID");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        String shipmentId = shipmentId_example; // String | Shipment Id Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentInfo] result = apiInstance.schedulerGetshipmentByShipmentIdByAPIID(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerGetshipmentByShipmentIdByAPIID");
            e.printStackTrace();
        }
    }
}
String *shipmentId = shipmentId_example; // Shipment Id Number
String *apiKey = apiKey_example; // AGS - API Key

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Get a Shipment by ShipmentId by API ID. 
(APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)
[apiInstance schedulerGetshipmentByShipmentIdByAPIIDWith:shipmentId
    apiKey:apiKey
              completionHandler: ^(array[ShipmentInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var shipmentId = shipmentId_example; // {String} Shipment Id Number

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerGetshipmentByShipmentIdByAPIID(shipmentId, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerGetshipmentByShipmentIdByAPIIDExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var shipmentId = shipmentId_example;  // String | Shipment Id Number
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get a Shipment by ShipmentId by API ID. 
(APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)
                array[ShipmentInfo] result = apiInstance.schedulerGetshipmentByShipmentIdByAPIID(shipmentId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerGetshipmentByShipmentIdByAPIID: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$shipmentId = shipmentId_example; // String | Shipment Id Number
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->schedulerGetshipmentByShipmentIdByAPIID($shipmentId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerGetshipmentByShipmentIdByAPIID: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $shipmentId = shipmentId_example; # String | Shipment Id Number
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->schedulerGetshipmentByShipmentIdByAPIID(shipmentId => $shipmentId, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerGetshipmentByShipmentIdByAPIID: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
shipmentId = shipmentId_example # String | Shipment Id Number
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get a Shipment by ShipmentId by API ID. 
(APPOINTMENT EXPIRES 15 MINUTES AFTER RESPONSE)
    api_response = api_instance.scheduler_getshipment_by_shipment_id_by_apiid(shipmentId, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerGetshipmentByShipmentIdByAPIID: %s\n" % e)

Parameters

Query parameters
Name Description
shipmentId*
String
Shipment Id Number
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

{headerData={apikey=null, billtonumber=0, housenumber=0, quoteno=0, shipmentid=0, activatestatus=false, message=null}, originatorInfo={name=null, phone=null, email=null}, activatorInfo={name=null, phone=null, email=null}, shipperInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, shipperreference=null}, shipperReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, consigneeInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, consigneereference=null}, consigneeReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, serviceInfo={service=null, readydate=null, readytime=0, closetime=0, declaredvalue=0}, pieceInfo={totalpieces=0, totalweight=0, pieces=[]}, partsInfo=[], specialInstructions={specialinstructionS1=null, specialinstructionS2=null, specialinstructionS3=null, specialinstructionS4=null, specialinstructionS5=null}, tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}, additionalCharges={chargE1=null, chargE2=null, chargE3=null, chargE4=null, chargE5=null, chargE6=null, chargE7=null, chargE8=null, chargE9=null, chargE10=null}, quoteCharges={totalcharges=null, charges=[]}, documentInfos=[]}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - The Default Scheduler Appointment was NOT FOUND


SaveAPIAppointment

Save API Appointment with the selected Date and Time.

API access URL. POST https://api1.agsystems.com/api/Scheduler/saveAPIAppointment


/api/Scheduler/saveAPIAppointment

Usage and SDK Samples

curl -X POST "http://localhost:62684/api/Scheduler/saveAPIAppointment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        AppointmentDataSubmit appointmentDataSubmit = ; // AppointmentDataSubmit | 
        try {
            Object result = apiInstance.schedulerSaveAPIAppointment(appointmentDataSubmit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerSaveAPIAppointment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        AppointmentDataSubmit appointmentDataSubmit = ; // AppointmentDataSubmit | 
        try {
            Object result = apiInstance.schedulerSaveAPIAppointment(appointmentDataSubmit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerSaveAPIAppointment");
            e.printStackTrace();
        }
    }
}
AppointmentDataSubmit *appointmentDataSubmit = ; // 

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Save API Appointment with the selected Date and Time.
[apiInstance schedulerSaveAPIAppointmentWith:appointmentDataSubmit
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var appointmentDataSubmit = ; // {AppointmentDataSubmit} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerSaveAPIAppointment(appointmentDataSubmit, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerSaveAPIAppointmentExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var appointmentDataSubmit = new AppointmentDataSubmit(); // AppointmentDataSubmit | 

            try
            {
                // Save API Appointment with the selected Date and Time.
                Object result = apiInstance.schedulerSaveAPIAppointment(appointmentDataSubmit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerSaveAPIAppointment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$appointmentDataSubmit = ; // AppointmentDataSubmit | 

try {
    $result = $api_instance->schedulerSaveAPIAppointment($appointmentDataSubmit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerSaveAPIAppointment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $appointmentDataSubmit = WWW::SwaggerClient::Object::AppointmentDataSubmit->new(); # AppointmentDataSubmit | 

eval { 
    my $result = $api_instance->schedulerSaveAPIAppointment(appointmentDataSubmit => $appointmentDataSubmit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerSaveAPIAppointment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
appointmentDataSubmit =  # AppointmentDataSubmit | 

try: 
    # Save API Appointment with the selected Date and Time.
    api_response = api_instance.scheduler_save_api_appointment(appointmentDataSubmit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerSaveAPIAppointment: %s\n" % e)

Parameters

Body parameters
Name Description
appointmentDataSubmit *

Responses

Status: 200 - Returns the String SUCCESS

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - Returns the FAILURE message


SaveAppointment

Schedule Appointment with the selected Date and Time.

API access URL. POST https://api1.agsystems.com/api/Scheduler/saveAppointment


/api/Scheduler/saveAppointment

Usage and SDK Samples

curl -X POST "http://localhost:62684/api/Scheduler/saveAppointment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SchedulerApi;

import java.io.File;
import java.util.*;

public class SchedulerApiExample {

    public static void main(String[] args) {
        
        SchedulerApi apiInstance = new SchedulerApi();
        SchedulerDataSubmit schedulerDataSubmit = ; // SchedulerDataSubmit | 
        try {
            Object result = apiInstance.schedulerSaveAppointment(schedulerDataSubmit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerSaveAppointment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.SchedulerApi;

public class SchedulerApiExample {

    public static void main(String[] args) {
        SchedulerApi apiInstance = new SchedulerApi();
        SchedulerDataSubmit schedulerDataSubmit = ; // SchedulerDataSubmit | 
        try {
            Object result = apiInstance.schedulerSaveAppointment(schedulerDataSubmit);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SchedulerApi#schedulerSaveAppointment");
            e.printStackTrace();
        }
    }
}
SchedulerDataSubmit *schedulerDataSubmit = ; // 

SchedulerApi *apiInstance = [[SchedulerApi alloc] init];

// Schedule Appointment with the selected Date and Time.
[apiInstance schedulerSaveAppointmentWith:schedulerDataSubmit
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.SchedulerApi()

var schedulerDataSubmit = ; // {SchedulerDataSubmit} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.schedulerSaveAppointment(schedulerDataSubmit, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class schedulerSaveAppointmentExample
    {
        public void main()
        {
            
            var apiInstance = new SchedulerApi();
            var schedulerDataSubmit = new SchedulerDataSubmit(); // SchedulerDataSubmit | 

            try
            {
                // Schedule Appointment with the selected Date and Time.
                Object result = apiInstance.schedulerSaveAppointment(schedulerDataSubmit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SchedulerApi.schedulerSaveAppointment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\SchedulerApi();
$schedulerDataSubmit = ; // SchedulerDataSubmit | 

try {
    $result = $api_instance->schedulerSaveAppointment($schedulerDataSubmit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SchedulerApi->schedulerSaveAppointment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::SchedulerApi;

my $api_instance = WWW::SwaggerClient::SchedulerApi->new();
my $schedulerDataSubmit = WWW::SwaggerClient::Object::SchedulerDataSubmit->new(); # SchedulerDataSubmit | 

eval { 
    my $result = $api_instance->schedulerSaveAppointment(schedulerDataSubmit => $schedulerDataSubmit);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling SchedulerApi->schedulerSaveAppointment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.SchedulerApi()
schedulerDataSubmit =  # SchedulerDataSubmit | 

try: 
    # Schedule Appointment with the selected Date and Time.
    api_response = api_instance.scheduler_save_appointment(schedulerDataSubmit)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling SchedulerApi->schedulerSaveAppointment: %s\n" % e)

Parameters

Body parameters
Name Description
schedulerDataSubmit *

Responses

Status: 200 - Returns the String SUCCESS

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response

Status: 404 - Returns the FAILURE message


Shipment

ActivateShipment


/api/Shipment/ActivateShipment

Usage and SDK Samples

curl -X POST "http://localhost:62684/api/Shipment/ActivateShipment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentApi;

import java.io.File;
import java.util.*;

public class ShipmentApiExample {

    public static void main(String[] args) {
        
        ShipmentApi apiInstance = new ShipmentApi();
        ShipmentInfo shipmentInfo = ; // ShipmentInfo | 
        try {
            array[ShipmentInfo] result = apiInstance.shipmentActivateShipment(shipmentInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentActivateShipment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentApi;

public class ShipmentApiExample {

    public static void main(String[] args) {
        ShipmentApi apiInstance = new ShipmentApi();
        ShipmentInfo shipmentInfo = ; // ShipmentInfo | 
        try {
            array[ShipmentInfo] result = apiInstance.shipmentActivateShipment(shipmentInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentActivateShipment");
            e.printStackTrace();
        }
    }
}
ShipmentInfo *shipmentInfo = ; // 

ShipmentApi *apiInstance = [[ShipmentApi alloc] init];

[apiInstance shipmentActivateShipmentWith:shipmentInfo
              completionHandler: ^(array[ShipmentInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentApi()

var shipmentInfo = ; // {ShipmentInfo} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentActivateShipment(shipmentInfo, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentActivateShipmentExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentApi();
            var shipmentInfo = new ShipmentInfo(); // ShipmentInfo | 

            try
            {
                array[ShipmentInfo] result = apiInstance.shipmentActivateShipment(shipmentInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentApi.shipmentActivateShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentApi();
$shipmentInfo = ; // ShipmentInfo | 

try {
    $result = $api_instance->shipmentActivateShipment($shipmentInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->shipmentActivateShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentApi;

my $api_instance = WWW::SwaggerClient::ShipmentApi->new();
my $shipmentInfo = WWW::SwaggerClient::Object::ShipmentInfo->new(); # ShipmentInfo | 

eval { 
    my $result = $api_instance->shipmentActivateShipment(shipmentInfo => $shipmentInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentApi->shipmentActivateShipment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentApi()
shipmentInfo =  # ShipmentInfo | 

try: 
    api_response = api_instance.shipment_activate_shipment(shipmentInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentApi->shipmentActivateShipment: %s\n" % e)

Parameters

Body parameters
Name Description
shipmentInfo *

Responses

Status: 200 - OK

{headerData={apikey=null, billtonumber=0, housenumber=0, quoteno=0, shipmentid=0, activatestatus=false, message=null}, originatorInfo={name=null, phone=null, email=null}, activatorInfo={name=null, phone=null, email=null}, shipperInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, shipperreference=null}, shipperReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, consigneeInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, consigneereference=null}, consigneeReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, serviceInfo={service=null, readydate=null, readytime=0, closetime=0, declaredvalue=0}, pieceInfo={totalpieces=0, totalweight=0, pieces=[]}, partsInfo=[], specialInstructions={specialinstructionS1=null, specialinstructionS2=null, specialinstructionS3=null, specialinstructionS4=null, specialinstructionS5=null}, tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}, additionalCharges={chargE1=null, chargE2=null, chargE3=null, chargE4=null, chargE5=null, chargE6=null, chargE7=null, chargE8=null, chargE9=null, chargE10=null}, quoteCharges={totalcharges=null, charges=[]}, documentInfos=[]}

CreateShipment

Create an AGS Shipment.

API access URL to Activate a returned Shipment by providing the minimum required parameters within the body of the POST request. POST https://api1.agsystems.com/api/Shipment/createShipment


/api/Shipment/CreateShipment

Usage and SDK Samples

curl -X POST "http://localhost:62684/api/Shipment/CreateShipment"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentApi;

import java.io.File;
import java.util.*;

public class ShipmentApiExample {

    public static void main(String[] args) {
        
        ShipmentApi apiInstance = new ShipmentApi();
        ShipmentInfo shipmentInfo = ; // ShipmentInfo | 
        try {
            array[ShipmentInfo] result = apiInstance.shipmentCreateShipment(shipmentInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentCreateShipment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentApi;

public class ShipmentApiExample {

    public static void main(String[] args) {
        ShipmentApi apiInstance = new ShipmentApi();
        ShipmentInfo shipmentInfo = ; // ShipmentInfo | 
        try {
            array[ShipmentInfo] result = apiInstance.shipmentCreateShipment(shipmentInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentCreateShipment");
            e.printStackTrace();
        }
    }
}
ShipmentInfo *shipmentInfo = ; // 

ShipmentApi *apiInstance = [[ShipmentApi alloc] init];

// Create an AGS Shipment.
[apiInstance shipmentCreateShipmentWith:shipmentInfo
              completionHandler: ^(array[ShipmentInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentApi()

var shipmentInfo = ; // {ShipmentInfo} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentCreateShipment(shipmentInfo, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentCreateShipmentExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentApi();
            var shipmentInfo = new ShipmentInfo(); // ShipmentInfo | 

            try
            {
                // Create an AGS Shipment.
                array[ShipmentInfo] result = apiInstance.shipmentCreateShipment(shipmentInfo);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentApi.shipmentCreateShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentApi();
$shipmentInfo = ; // ShipmentInfo | 

try {
    $result = $api_instance->shipmentCreateShipment($shipmentInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->shipmentCreateShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentApi;

my $api_instance = WWW::SwaggerClient::ShipmentApi->new();
my $shipmentInfo = WWW::SwaggerClient::Object::ShipmentInfo->new(); # ShipmentInfo | 

eval { 
    my $result = $api_instance->shipmentCreateShipment(shipmentInfo => $shipmentInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentApi->shipmentCreateShipment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentApi()
shipmentInfo =  # ShipmentInfo | 

try: 
    # Create an AGS Shipment.
    api_response = api_instance.shipment_create_shipment(shipmentInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentApi->shipmentCreateShipment: %s\n" % e)

Parameters

Body parameters
Name Description
shipmentInfo *

Responses

Status: 200 - OK

{headerData={apikey=null, billtonumber=0, housenumber=0, quoteno=0, shipmentid=0, activatestatus=false, message=null}, originatorInfo={name=null, phone=null, email=null}, activatorInfo={name=null, phone=null, email=null}, shipperInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, shipperreference=null}, shipperReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, consigneeInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, consigneereference=null}, consigneeReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, serviceInfo={service=null, readydate=null, readytime=0, closetime=0, declaredvalue=0}, pieceInfo={totalpieces=0, totalweight=0, pieces=[]}, partsInfo=[], specialInstructions={specialinstructionS1=null, specialinstructionS2=null, specialinstructionS3=null, specialinstructionS4=null, specialinstructionS5=null}, tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}, additionalCharges={chargE1=null, chargE2=null, chargE3=null, chargE4=null, chargE5=null, chargE6=null, chargE7=null, chargE8=null, chargE9=null, chargE10=null}, quoteCharges={totalcharges=null, charges=[]}, documentInfos=[]}

Status: 400 - Incorrect or Missing Data. Defined message provided as a Response


GetDefaultServices

Retrieve Default Charge Services assigned to the APIKEY.

API access URL to retrieve default services assigned to the provided APIKEY GET https://api1.agsystems.com/api/Shipment/GetDefaultServices?apiKey= apikey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Shipment/GetDefaultServices

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Shipment/GetDefaultServices?apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentApi;

import java.io.File;
import java.util.*;

public class ShipmentApiExample {

    public static void main(String[] args) {
        
        ShipmentApi apiInstance = new ShipmentApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[BillTos] result = apiInstance.shipmentGetDefaultServices(apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentGetDefaultServices");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentApi;

public class ShipmentApiExample {

    public static void main(String[] args) {
        ShipmentApi apiInstance = new ShipmentApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[BillTos] result = apiInstance.shipmentGetDefaultServices(apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentGetDefaultServices");
            e.printStackTrace();
        }
    }
}
String *apiKey = apiKey_example; // AGS - API Key

ShipmentApi *apiInstance = [[ShipmentApi alloc] init];

// Retrieve Default Charge Services assigned to the APIKEY.
[apiInstance shipmentGetDefaultServicesWith:apiKey
              completionHandler: ^(array[BillTos] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentApi()

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentGetDefaultServices(apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentGetDefaultServicesExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentApi();
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Retrieve Default Charge Services assigned to the APIKEY.
                array[BillTos] result = apiInstance.shipmentGetDefaultServices(apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentApi.shipmentGetDefaultServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentApi();
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->shipmentGetDefaultServices($apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->shipmentGetDefaultServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentApi;

my $api_instance = WWW::SwaggerClient::ShipmentApi->new();
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->shipmentGetDefaultServices(apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentApi->shipmentGetDefaultServices: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentApi()
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Retrieve Default Charge Services assigned to the APIKEY.
    api_response = api_instance.shipment_get_default_services(apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentApi->shipmentGetDefaultServices: %s\n" % e)

Parameters

Query parameters
Name Description
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

{key=null, id=0, billTo=0, services=[], accessorials=[]}

Status: 404 - The Services are NOT FOUND


GetShipment

Retrieve a Shipment Created but not Activated.

API access URL to retrieve a generated shipment. GET https://api1.agsystems.com/api/shipment/GetShipment?shipmentId=&amp;apiKey= quoteId: "1234567" - Where quote ID is a 7 digit integer. apikey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/Shipment/GetShipment

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/Shipment/GetShipment?apiKey=&shipmentId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentApi;

import java.io.File;
import java.util.*;

public class ShipmentApiExample {

    public static void main(String[] args) {
        
        ShipmentApi apiInstance = new ShipmentApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        Long shipmentId = 789; // Long | Previously Created Shipment Id
        try {
            array[ShipmentInfo] result = apiInstance.shipmentGetShipment(apiKey, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentGetShipment");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentApi;

public class ShipmentApiExample {

    public static void main(String[] args) {
        ShipmentApi apiInstance = new ShipmentApi();
        String apiKey = apiKey_example; // String | AGS - API Key
        Long shipmentId = 789; // Long | Previously Created Shipment Id
        try {
            array[ShipmentInfo] result = apiInstance.shipmentGetShipment(apiKey, shipmentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentApi#shipmentGetShipment");
            e.printStackTrace();
        }
    }
}
String *apiKey = apiKey_example; // AGS - API Key
Long *shipmentId = 789; // Previously Created Shipment Id

ShipmentApi *apiInstance = [[ShipmentApi alloc] init];

// Retrieve a Shipment Created but not Activated.
[apiInstance shipmentGetShipmentWith:apiKey
    shipmentId:shipmentId
              completionHandler: ^(array[ShipmentInfo] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentApi()

var apiKey = apiKey_example; // {String} AGS - API Key

var shipmentId = 789; // {Long} Previously Created Shipment Id


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentGetShipment(apiKey, shipmentId, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentGetShipmentExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentApi();
            var apiKey = apiKey_example;  // String | AGS - API Key
            var shipmentId = 789;  // Long | Previously Created Shipment Id

            try
            {
                // Retrieve a Shipment Created but not Activated.
                array[ShipmentInfo] result = apiInstance.shipmentGetShipment(apiKey, shipmentId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentApi.shipmentGetShipment: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentApi();
$apiKey = apiKey_example; // String | AGS - API Key
$shipmentId = 789; // Long | Previously Created Shipment Id

try {
    $result = $api_instance->shipmentGetShipment($apiKey, $shipmentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->shipmentGetShipment: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentApi;

my $api_instance = WWW::SwaggerClient::ShipmentApi->new();
my $apiKey = apiKey_example; # String | AGS - API Key
my $shipmentId = 789; # Long | Previously Created Shipment Id

eval { 
    my $result = $api_instance->shipmentGetShipment(apiKey => $apiKey, shipmentId => $shipmentId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentApi->shipmentGetShipment: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentApi()
apiKey = apiKey_example # String | AGS - API Key
shipmentId = 789 # Long | Previously Created Shipment Id

try: 
    # Retrieve a Shipment Created but not Activated.
    api_response = api_instance.shipment_get_shipment(apiKey, shipmentId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentApi->shipmentGetShipment: %s\n" % e)

Parameters

Query parameters
Name Description
apiKey*
String
AGS - API Key
Required
shipmentId*
Long (int64)
Previously Created Shipment Id
Required

Responses

Status: 200 - OK

{headerData={apikey=null, billtonumber=0, housenumber=0, quoteno=0, shipmentid=0, activatestatus=false, message=null}, originatorInfo={name=null, phone=null, email=null}, activatorInfo={name=null, phone=null, email=null}, shipperInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, shipperreference=null}, shipperReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, consigneeInfo={name=null, addresS1=null, addresS2=null, city=null, state=null, country=null, zipcode=null, phone=null, fax=null, contact=null, email=null, consigneereference=null}, consigneeReference={referencE1=null, referencE2=null, referencE3=null, referencE4=null, referencE5=null, referencE6=null, referencE7=null, referencE8=null, referencE9=null, referencE10=null}, serviceInfo={service=null, readydate=null, readytime=0, closetime=0, declaredvalue=0}, pieceInfo={totalpieces=0, totalweight=0, pieces=[]}, partsInfo=[], specialInstructions={specialinstructionS1=null, specialinstructionS2=null, specialinstructionS3=null, specialinstructionS4=null, specialinstructionS5=null}, tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}, additionalCharges={chargE1=null, chargE2=null, chargE3=null, chargE4=null, chargE5=null, chargE6=null, chargE7=null, chargE8=null, chargE9=null, chargE10=null}, quoteCharges={totalcharges=null, charges=[]}, documentInfos=[]}

Status: 404 - The Shipment is NOT FOUND


ShipmentDetail

ByShipmentId

Get Shipment Detail Information from Shipment Id.

API acces url. GET https://api1.agsystems.com/api/ShipmentDetail/ByShipmentId?shipmentId=&amp;apiKey= ShipmentId : "1234567" - Where ShipmentId is a 7 digit integer. apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/ShipmentDetail/ByShipmentId

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/ShipmentDetail/ByShipmentId?shipmentId=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentDetailApi;

import java.io.File;
import java.util.*;

public class ShipmentDetailApiExample {

    public static void main(String[] args) {
        
        ShipmentDetailApi apiInstance = new ShipmentDetailApi();
        String shipmentId = shipmentId_example; // String | Given ShipmentId Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[Shipment] result = apiInstance.shipmentDetailByShipmentId(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentDetailApi#shipmentDetailByShipmentId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentDetailApi;

public class ShipmentDetailApiExample {

    public static void main(String[] args) {
        ShipmentDetailApi apiInstance = new ShipmentDetailApi();
        String shipmentId = shipmentId_example; // String | Given ShipmentId Number
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[Shipment] result = apiInstance.shipmentDetailByShipmentId(shipmentId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentDetailApi#shipmentDetailByShipmentId");
            e.printStackTrace();
        }
    }
}
String *shipmentId = shipmentId_example; // Given ShipmentId Number
String *apiKey = apiKey_example; // AGS - API Key

ShipmentDetailApi *apiInstance = [[ShipmentDetailApi alloc] init];

// Get Shipment Detail Information from Shipment Id.
[apiInstance shipmentDetailByShipmentIdWith:shipmentId
    apiKey:apiKey
              completionHandler: ^(array[Shipment] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentDetailApi()

var shipmentId = shipmentId_example; // {String} Given ShipmentId Number

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentDetailByShipmentId(shipmentId, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentDetailByShipmentIdExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentDetailApi();
            var shipmentId = shipmentId_example;  // String | Given ShipmentId Number
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Get Shipment Detail Information from Shipment Id.
                array[Shipment] result = apiInstance.shipmentDetailByShipmentId(shipmentId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentDetailApi.shipmentDetailByShipmentId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentDetailApi();
$shipmentId = shipmentId_example; // String | Given ShipmentId Number
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->shipmentDetailByShipmentId($shipmentId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentDetailApi->shipmentDetailByShipmentId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentDetailApi;

my $api_instance = WWW::SwaggerClient::ShipmentDetailApi->new();
my $shipmentId = shipmentId_example; # String | Given ShipmentId Number
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->shipmentDetailByShipmentId(shipmentId => $shipmentId, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentDetailApi->shipmentDetailByShipmentId: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentDetailApi()
shipmentId = shipmentId_example # String | Given ShipmentId Number
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Get Shipment Detail Information from Shipment Id.
    api_response = api_instance.shipment_detail_by_shipment_id(shipmentId, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentDetailApi->shipmentDetailByShipmentId: %s\n" % e)

Parameters

Query parameters
Name Description
shipmentId*
String
Given ShipmentId Number
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{airWaybillSuffix=0, declaredValue=0, destinationAirport=null, destinationArea=null, exportOrImport=E, handlingStation=null, houseAirWaybillNumber=null, internationalOrDomestic=D, originAirport=null, originArea=null, prepaidCollectOther=null, shipmentID=2000000, houseService=null, charges=[], mileStones=[], piece={totalpieces=0, totalweight=0, pieces=[]}, parts=[], parties=[], specialInstructions=[], shipmentNotes=[], trackings=[], trackingUpdates=[], tradeShow={boothnumbers=null, contactsitename=null, contactsitephone=null, decorator=null, exhibitor=null, showname=null}}]

Status: 400 - Issues with Input Values

Status: 404 - The Shipment is NOT FOUND


ShipmentTracking

ByConsigneeReference

Track by Dates and Consignee Reference Id.

API access url. GET https://api1.agsystems.com/api/ShipmentTracking/ByConsigneeReference?fromDate=&amp;toDate=&amp;consigneeId=&amp;apiKey= fromDate : "yyyyMMdd" toDate : "yyyyMMdd" consigneeId : "XXXXXXX" apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/ShipmentTracking/ByConsigneeReference

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/ShipmentTracking/ByConsigneeReference?fromDate=&toDate=&consigneeId=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentTrackingApi;

import java.io.File;
import java.util.*;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String consigneeId = consigneeId_example; // String | Consignee Reference Id
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByConsigneeReference(fromDate, toDate, consigneeId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByConsigneeReference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentTrackingApi;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String consigneeId = consigneeId_example; // String | Consignee Reference Id
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByConsigneeReference(fromDate, toDate, consigneeId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByConsigneeReference");
            e.printStackTrace();
        }
    }
}
String *fromDate = fromDate_example; // From Date
String *toDate = toDate_example; // To Date
String *consigneeId = consigneeId_example; // Consignee Reference Id
String *apiKey = apiKey_example; // AGS - API Key

ShipmentTrackingApi *apiInstance = [[ShipmentTrackingApi alloc] init];

// Track by Dates and Consignee Reference Id.
[apiInstance shipmentTrackingByConsigneeReferenceWith:fromDate
    toDate:toDate
    consigneeId:consigneeId
    apiKey:apiKey
              completionHandler: ^(array[ShipmentList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentTrackingApi()

var fromDate = fromDate_example; // {String} From Date

var toDate = toDate_example; // {String} To Date

var consigneeId = consigneeId_example; // {String} Consignee Reference Id

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentTrackingByConsigneeReference(fromDate, toDate, consigneeId, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentTrackingByConsigneeReferenceExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentTrackingApi();
            var fromDate = fromDate_example;  // String | From Date
            var toDate = toDate_example;  // String | To Date
            var consigneeId = consigneeId_example;  // String | Consignee Reference Id
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Track by Dates and Consignee Reference Id.
                array[ShipmentList] result = apiInstance.shipmentTrackingByConsigneeReference(fromDate, toDate, consigneeId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentTrackingApi.shipmentTrackingByConsigneeReference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentTrackingApi();
$fromDate = fromDate_example; // String | From Date
$toDate = toDate_example; // String | To Date
$consigneeId = consigneeId_example; // String | Consignee Reference Id
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->shipmentTrackingByConsigneeReference($fromDate, $toDate, $consigneeId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentTrackingApi->shipmentTrackingByConsigneeReference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentTrackingApi;

my $api_instance = WWW::SwaggerClient::ShipmentTrackingApi->new();
my $fromDate = fromDate_example; # String | From Date
my $toDate = toDate_example; # String | To Date
my $consigneeId = consigneeId_example; # String | Consignee Reference Id
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->shipmentTrackingByConsigneeReference(fromDate => $fromDate, toDate => $toDate, consigneeId => $consigneeId, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentTrackingApi->shipmentTrackingByConsigneeReference: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentTrackingApi()
fromDate = fromDate_example # String | From Date
toDate = toDate_example # String | To Date
consigneeId = consigneeId_example # String | Consignee Reference Id
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Track by Dates and Consignee Reference Id.
    api_response = api_instance.shipment_tracking_by_consignee_reference(fromDate, toDate, consigneeId, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentTrackingApi->shipmentTrackingByConsigneeReference: %s\n" % e)

Parameters

Query parameters
Name Description
fromDate*
String
From Date
Required
toDate*
String
To Date
Required
consigneeId*
String
Consignee Reference Id
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{airWaybillSuffix=0, bookingStation=null, chargeableWeight=0, consigneeID=0, consigneeName=null, consigneeCity=null, consigneeStateProvince=null, consigneeReferenceNumber=null, destinationAirport=null, destinationArea=null, exportOrImport=E, handlingStation=null, houseAirWaybillNumber=null, internationalOrDomestic=D, originAirport=null, originArea=null, podDate=0001-01-01T00:00:00, scheduleDeliveryDate=null, service=null, shipmentID=2000000, shipperID=0, shipperName=null, shipperCity=null, shipperStateProvince=null, shipperReferenceNumber=null, readyDate=0001-01-01T00:00:00, totalPieces=0}]

Status: 400 - Date Information Submission Issue

Status: 404 - The Shipment Tracking is NOT FOUND


ByDeliveryDate

Track by Delivery Dates.

API access url. GET https://api1.agsystems.com/api/ShipmentTracking/ByDeliveryDate?fromDate=&amp;toDate=&amp;apiKey= fromDate : "yyyyMMdd" toDate : "yyyyMMdd" apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/ShipmentTracking/ByDeliveryDate

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/ShipmentTracking/ByDeliveryDate?fromDate=&toDate=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentTrackingApi;

import java.io.File;
import java.util.*;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByDeliveryDate(fromDate, toDate, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByDeliveryDate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentTrackingApi;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByDeliveryDate(fromDate, toDate, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByDeliveryDate");
            e.printStackTrace();
        }
    }
}
String *fromDate = fromDate_example; // From Date
String *toDate = toDate_example; // To Date
String *apiKey = apiKey_example; // AGS - API Key

ShipmentTrackingApi *apiInstance = [[ShipmentTrackingApi alloc] init];

// Track by Delivery Dates.
[apiInstance shipmentTrackingByDeliveryDateWith:fromDate
    toDate:toDate
    apiKey:apiKey
              completionHandler: ^(array[ShipmentList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentTrackingApi()

var fromDate = fromDate_example; // {String} From Date

var toDate = toDate_example; // {String} To Date

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentTrackingByDeliveryDate(fromDate, toDate, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentTrackingByDeliveryDateExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentTrackingApi();
            var fromDate = fromDate_example;  // String | From Date
            var toDate = toDate_example;  // String | To Date
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Track by Delivery Dates.
                array[ShipmentList] result = apiInstance.shipmentTrackingByDeliveryDate(fromDate, toDate, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentTrackingApi.shipmentTrackingByDeliveryDate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentTrackingApi();
$fromDate = fromDate_example; // String | From Date
$toDate = toDate_example; // String | To Date
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->shipmentTrackingByDeliveryDate($fromDate, $toDate, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentTrackingApi->shipmentTrackingByDeliveryDate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentTrackingApi;

my $api_instance = WWW::SwaggerClient::ShipmentTrackingApi->new();
my $fromDate = fromDate_example; # String | From Date
my $toDate = toDate_example; # String | To Date
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->shipmentTrackingByDeliveryDate(fromDate => $fromDate, toDate => $toDate, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentTrackingApi->shipmentTrackingByDeliveryDate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentTrackingApi()
fromDate = fromDate_example # String | From Date
toDate = toDate_example # String | To Date
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Track by Delivery Dates.
    api_response = api_instance.shipment_tracking_by_delivery_date(fromDate, toDate, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentTrackingApi->shipmentTrackingByDeliveryDate: %s\n" % e)

Parameters

Query parameters
Name Description
fromDate*
String
From Date
Required
toDate*
String
To Date
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{airWaybillSuffix=0, bookingStation=null, chargeableWeight=0, consigneeID=0, consigneeName=null, consigneeCity=null, consigneeStateProvince=null, consigneeReferenceNumber=null, destinationAirport=null, destinationArea=null, exportOrImport=E, handlingStation=null, houseAirWaybillNumber=null, internationalOrDomestic=D, originAirport=null, originArea=null, podDate=0001-01-01T00:00:00, scheduleDeliveryDate=null, service=null, shipmentID=2000000, shipperID=0, shipperName=null, shipperCity=null, shipperStateProvince=null, shipperReferenceNumber=null, readyDate=0001-01-01T00:00:00, totalPieces=0}]

Status: 400 - Date Information Submission Issue

Status: 404 - The Shipment Tracking is NOT FOUND


ByHouseNumber

Track by House Number (Bill Of Lading).

API acces url. GET https://api1.agsystems.com/api/ShipmentTracking/ByHouseNumber?houseNumber=&amp;apiKey= houseNumber : "1234567" - Where houseNumber is a 7 digit integer. apikey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/ShipmentTracking/ByHouseNumber

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/ShipmentTracking/ByHouseNumber?houseNumber=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentTrackingApi;

import java.io.File;
import java.util.*;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String houseNumber = houseNumber_example; // String | Given House Number (Bill of Lading)
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByHouseNumber(houseNumber, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByHouseNumber");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentTrackingApi;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String houseNumber = houseNumber_example; // String | Given House Number (Bill of Lading)
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByHouseNumber(houseNumber, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByHouseNumber");
            e.printStackTrace();
        }
    }
}
String *houseNumber = houseNumber_example; // Given House Number (Bill of Lading)
String *apiKey = apiKey_example; // AGS - API Key

ShipmentTrackingApi *apiInstance = [[ShipmentTrackingApi alloc] init];

// Track by House Number (Bill Of Lading).
[apiInstance shipmentTrackingByHouseNumberWith:houseNumber
    apiKey:apiKey
              completionHandler: ^(array[ShipmentList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentTrackingApi()

var houseNumber = houseNumber_example; // {String} Given House Number (Bill of Lading)

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentTrackingByHouseNumber(houseNumber, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentTrackingByHouseNumberExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentTrackingApi();
            var houseNumber = houseNumber_example;  // String | Given House Number (Bill of Lading)
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Track by House Number (Bill Of Lading).
                array[ShipmentList] result = apiInstance.shipmentTrackingByHouseNumber(houseNumber, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentTrackingApi.shipmentTrackingByHouseNumber: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentTrackingApi();
$houseNumber = houseNumber_example; // String | Given House Number (Bill of Lading)
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->shipmentTrackingByHouseNumber($houseNumber, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentTrackingApi->shipmentTrackingByHouseNumber: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentTrackingApi;

my $api_instance = WWW::SwaggerClient::ShipmentTrackingApi->new();
my $houseNumber = houseNumber_example; # String | Given House Number (Bill of Lading)
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->shipmentTrackingByHouseNumber(houseNumber => $houseNumber, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentTrackingApi->shipmentTrackingByHouseNumber: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentTrackingApi()
houseNumber = houseNumber_example # String | Given House Number (Bill of Lading)
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Track by House Number (Bill Of Lading).
    api_response = api_instance.shipment_tracking_by_house_number(houseNumber, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentTrackingApi->shipmentTrackingByHouseNumber: %s\n" % e)

Parameters

Query parameters
Name Description
houseNumber*
String
Given House Number (Bill of Lading)
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{airWaybillSuffix=0, bookingStation=null, chargeableWeight=0, consigneeID=0, consigneeName=null, consigneeCity=null, consigneeStateProvince=null, consigneeReferenceNumber=null, destinationAirport=null, destinationArea=null, exportOrImport=E, handlingStation=null, houseAirWaybillNumber=null, internationalOrDomestic=D, originAirport=null, originArea=null, podDate=0001-01-01T00:00:00, scheduleDeliveryDate=null, service=null, shipmentID=2000000, shipperID=0, shipperName=null, shipperCity=null, shipperStateProvince=null, shipperReferenceNumber=null, readyDate=0001-01-01T00:00:00, totalPieces=0}]

Status: 404 - The Shipment Tracking is NOT FOUND


ByReadyDate

Track by Ready Dates.

API access url. GET https://api1.agsystems.com/api/ShipmentTracking/ByReadyDate?fromDate=&amp;toDate=&amp;apiKey= fromDate : "yyyyMMdd" toDate : "yyyyMMdd" apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/ShipmentTracking/ByReadyDate

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/ShipmentTracking/ByReadyDate?fromDate=&toDate=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentTrackingApi;

import java.io.File;
import java.util.*;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByReadyDate(fromDate, toDate, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByReadyDate");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentTrackingApi;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByReadyDate(fromDate, toDate, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByReadyDate");
            e.printStackTrace();
        }
    }
}
String *fromDate = fromDate_example; // From Date
String *toDate = toDate_example; // To Date
String *apiKey = apiKey_example; // AGS - API Key

ShipmentTrackingApi *apiInstance = [[ShipmentTrackingApi alloc] init];

// Track by Ready Dates.
[apiInstance shipmentTrackingByReadyDateWith:fromDate
    toDate:toDate
    apiKey:apiKey
              completionHandler: ^(array[ShipmentList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentTrackingApi()

var fromDate = fromDate_example; // {String} From Date

var toDate = toDate_example; // {String} To Date

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentTrackingByReadyDate(fromDate, toDate, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentTrackingByReadyDateExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentTrackingApi();
            var fromDate = fromDate_example;  // String | From Date
            var toDate = toDate_example;  // String | To Date
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Track by Ready Dates.
                array[ShipmentList] result = apiInstance.shipmentTrackingByReadyDate(fromDate, toDate, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentTrackingApi.shipmentTrackingByReadyDate: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentTrackingApi();
$fromDate = fromDate_example; // String | From Date
$toDate = toDate_example; // String | To Date
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->shipmentTrackingByReadyDate($fromDate, $toDate, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentTrackingApi->shipmentTrackingByReadyDate: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentTrackingApi;

my $api_instance = WWW::SwaggerClient::ShipmentTrackingApi->new();
my $fromDate = fromDate_example; # String | From Date
my $toDate = toDate_example; # String | To Date
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->shipmentTrackingByReadyDate(fromDate => $fromDate, toDate => $toDate, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentTrackingApi->shipmentTrackingByReadyDate: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentTrackingApi()
fromDate = fromDate_example # String | From Date
toDate = toDate_example # String | To Date
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Track by Ready Dates.
    api_response = api_instance.shipment_tracking_by_ready_date(fromDate, toDate, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentTrackingApi->shipmentTrackingByReadyDate: %s\n" % e)

Parameters

Query parameters
Name Description
fromDate*
String
From Date
Required
toDate*
String
To Date
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{airWaybillSuffix=0, bookingStation=null, chargeableWeight=0, consigneeID=0, consigneeName=null, consigneeCity=null, consigneeStateProvince=null, consigneeReferenceNumber=null, destinationAirport=null, destinationArea=null, exportOrImport=E, handlingStation=null, houseAirWaybillNumber=null, internationalOrDomestic=D, originAirport=null, originArea=null, podDate=0001-01-01T00:00:00, scheduleDeliveryDate=null, service=null, shipmentID=2000000, shipperID=0, shipperName=null, shipperCity=null, shipperStateProvince=null, shipperReferenceNumber=null, readyDate=0001-01-01T00:00:00, totalPieces=0}]

Status: 400 - Date Information Submission Issue

Status: 404 - The Shipment Tracking is NOT FOUND


ByShipperReference

Track by Dates and Shipper Reference Id.

API access url. GET https://api1.agsystems.com/api/ShipmentTracking/ByShipperReference?fromDate=&amp;todate=&amp;referenceId=&amp;apiKey= fromDate : "yyyyMMdd" toDate : "yyyyMMdd" referenceId : "XXXXXXXX" apiKey : e.g. "b25b959554ed76058ac220b7b2e0a026" provided by AGS.


/api/ShipmentTracking/ByShipperReference

Usage and SDK Samples

curl -X GET "http://localhost:62684/api/ShipmentTracking/ByShipperReference?fromDate=&toDate=&referenceId=&apiKey="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ShipmentTrackingApi;

import java.io.File;
import java.util.*;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String referenceId = referenceId_example; // String | Shipper Reference Id
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByShipperReference(fromDate, toDate, referenceId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByShipperReference");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ShipmentTrackingApi;

public class ShipmentTrackingApiExample {

    public static void main(String[] args) {
        ShipmentTrackingApi apiInstance = new ShipmentTrackingApi();
        String fromDate = fromDate_example; // String | From Date
        String toDate = toDate_example; // String | To Date
        String referenceId = referenceId_example; // String | Shipper Reference Id
        String apiKey = apiKey_example; // String | AGS - API Key
        try {
            array[ShipmentList] result = apiInstance.shipmentTrackingByShipperReference(fromDate, toDate, referenceId, apiKey);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ShipmentTrackingApi#shipmentTrackingByShipperReference");
            e.printStackTrace();
        }
    }
}
String *fromDate = fromDate_example; // From Date
String *toDate = toDate_example; // To Date
String *referenceId = referenceId_example; // Shipper Reference Id
String *apiKey = apiKey_example; // AGS - API Key

ShipmentTrackingApi *apiInstance = [[ShipmentTrackingApi alloc] init];

// Track by Dates and Shipper Reference Id.
[apiInstance shipmentTrackingByShipperReferenceWith:fromDate
    toDate:toDate
    referenceId:referenceId
    apiKey:apiKey
              completionHandler: ^(array[ShipmentList] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var AssociatedGlobalSystems = require('associated_global_systems');

var api = new AssociatedGlobalSystems.ShipmentTrackingApi()

var fromDate = fromDate_example; // {String} From Date

var toDate = toDate_example; // {String} To Date

var referenceId = referenceId_example; // {String} Shipper Reference Id

var apiKey = apiKey_example; // {String} AGS - API Key


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.shipmentTrackingByShipperReference(fromDate, toDate, referenceId, apiKey, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class shipmentTrackingByShipperReferenceExample
    {
        public void main()
        {
            
            var apiInstance = new ShipmentTrackingApi();
            var fromDate = fromDate_example;  // String | From Date
            var toDate = toDate_example;  // String | To Date
            var referenceId = referenceId_example;  // String | Shipper Reference Id
            var apiKey = apiKey_example;  // String | AGS - API Key

            try
            {
                // Track by Dates and Shipper Reference Id.
                array[ShipmentList] result = apiInstance.shipmentTrackingByShipperReference(fromDate, toDate, referenceId, apiKey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ShipmentTrackingApi.shipmentTrackingByShipperReference: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\ShipmentTrackingApi();
$fromDate = fromDate_example; // String | From Date
$toDate = toDate_example; // String | To Date
$referenceId = referenceId_example; // String | Shipper Reference Id
$apiKey = apiKey_example; // String | AGS - API Key

try {
    $result = $api_instance->shipmentTrackingByShipperReference($fromDate, $toDate, $referenceId, $apiKey);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentTrackingApi->shipmentTrackingByShipperReference: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ShipmentTrackingApi;

my $api_instance = WWW::SwaggerClient::ShipmentTrackingApi->new();
my $fromDate = fromDate_example; # String | From Date
my $toDate = toDate_example; # String | To Date
my $referenceId = referenceId_example; # String | Shipper Reference Id
my $apiKey = apiKey_example; # String | AGS - API Key

eval { 
    my $result = $api_instance->shipmentTrackingByShipperReference(fromDate => $fromDate, toDate => $toDate, referenceId => $referenceId, apiKey => $apiKey);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ShipmentTrackingApi->shipmentTrackingByShipperReference: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.ShipmentTrackingApi()
fromDate = fromDate_example # String | From Date
toDate = toDate_example # String | To Date
referenceId = referenceId_example # String | Shipper Reference Id
apiKey = apiKey_example # String | AGS - API Key

try: 
    # Track by Dates and Shipper Reference Id.
    api_response = api_instance.shipment_tracking_by_shipper_reference(fromDate, toDate, referenceId, apiKey)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ShipmentTrackingApi->shipmentTrackingByShipperReference: %s\n" % e)

Parameters

Query parameters
Name Description
fromDate*
String
From Date
Required
toDate*
String
To Date
Required
referenceId*
String
Shipper Reference Id
Required
apiKey*
String
AGS - API Key
Required

Responses

Status: 200 - OK

[{airWaybillSuffix=0, bookingStation=null, chargeableWeight=0, consigneeID=0, consigneeName=null, consigneeCity=null, consigneeStateProvince=null, consigneeReferenceNumber=null, destinationAirport=null, destinationArea=null, exportOrImport=E, handlingStation=null, houseAirWaybillNumber=null, internationalOrDomestic=D, originAirport=null, originArea=null, podDate=0001-01-01T00:00:00, scheduleDeliveryDate=null, service=null, shipmentID=2000000, shipperID=0, shipperName=null, shipperCity=null, shipperStateProvince=null, shipperReferenceNumber=null, readyDate=0001-01-01T00:00:00, totalPieces=0}]

Status: 400 - Date Information Submission Issue

Status: 404 - The Shipment Tracking is NOT FOUND