Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

QuantumView

UPS Quantum View is a suite of services that gives you and your customers details regarding UPS shipments. # Reference - <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://developer.ups.com/api/reference/quantumview/business-rules%5C" rel="nofollow">https://developer.ups.com/api/reference/quantumview/business-rules\" target="_blank" rel="noopener">Business Rules - <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://developer.ups.com/api/reference/quantumview/appendix%5C" rel="nofollow">https://developer.ups.com/api/reference/quantumview/appendix\" target="_blank" rel="noopener">Appendix - <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://developer.ups.com/api/reference/quantumview/errors%5C" rel="nofollow">https://developer.ups.com/api/reference/quantumview/errors\" target="_blank" rel="noopener">Errors - <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://developer.ups.com/api/reference/quantumview/faq%5C" rel="nofollow">https://developer.ups.com/api/reference/quantumview/faq\" target="_blank" rel="noopener">FAQ

Try out UPS APIs with example requests using Postman. Explore API documentation and sample applications through GitHub.

<a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://god.gw.postman.com/run-collection/29542085-84cbd22f-67ec-4c9c-b500-620b266922c9?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-84cbd22f-67ec-4c9c-b500-620b266922c9%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417%5C" rel="nofollow">https://god.gw.postman.com/run-collection/29542085-84cbd22f-67ec-4c9c-b500-620b266922c9?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D29542085-84cbd22f-67ec-4c9c-b500-620b266922c9%26entityType%3Dcollection%26workspaceId%3D7e7595f0-4829-4f9a-aee1-75c126b9d417\" target="_blank" rel="noopener noreferrer"> <img src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://run.pstmn.io/button.svg%5C" rel="nofollow">https://run.pstmn.io/button.svg\" alt="Run In Postman" style="width: 128px; height: 32px;"> <a href="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://github.com/UPS-API%5C">https://github.com/UPS-API\" target="_blank" rel="noopener noreferrer"> <img src="proxy.php?url=https%3A%2F%2Fgithub.com%2F%3Ca+href%3D"https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg%5C" rel="nofollow">https://www.ups.com/assets/resources/webcontent/images/gitHubButton.svg\" alt="Open in GitHub " style="width: 128px; height: 32px;">

This PHP package is automatically generated by the Swagger Codegen project:

  • API version:
  • Package version: 1.0.9
  • Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/abantecart/ups-quantum-view.git"
    }
  ],
  "require": {
    "abantecart/ups-quantum-view": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/QuantumView/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: OAuth2
$config = UPS\QuantumView\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new UPS\QuantumView\Request\QuantumViewApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \UPS\QuantumView\QuantumView\QUANTUMVIEWRequestWrapper(); // \UPS\QuantumView\QuantumView\QUANTUMVIEWRequestWrapper | Generate sample code for popular API requests by selecting an example below. To view a full sample request and response, first click \"Authorize\" and enter your application credentials, then populate the required parameters above and click \"Try it out\".
$deprecated_version = "deprecated_version_example"; // string | Version of API.  Valid values: - v1

try {
    $result = $apiInstance->deprecatedQuantumView($body, $deprecated_version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuantumViewApi->deprecatedQuantumView: ', $e->getMessage(), PHP_EOL;
}

// Configure OAuth2 access token for authorization: OAuth2
$config = UPS\QuantumView\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new UPS\QuantumView\Request\QuantumViewApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$body = new \UPS\QuantumView\QuantumView\QUANTUMVIEWRequestWrapper(); // \UPS\QuantumView\QuantumView\QUANTUMVIEWRequestWrapper | Generate sample code for popular API requests by selecting an example below. To view a full sample request and response, first click \"Authorize\" and enter your application credentials, then populate the required parameters above and click \"Try it out\".
$version = "version_example"; // string | Version of API.  Valid values: - v3

try {
    $result = $apiInstance->quantumView($body, $version);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling QuantumViewApi->quantumView: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://wwwcie.ups.com/api

Class Method HTTP request Description
QuantumViewApi deprecatedQuantumView POST /quantumview/{deprecatedVersion}/events Quantum View
QuantumViewApi quantumView POST /quantumview/{version}/events Quantum View

Documentation For Models

Documentation For Authorization

OAuth2

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:

Author