swaggerlib/iws-isa

dev-main 2024-05-03 05:51 UTC

This package is auto-updated.

Last update: 2024-05-03 05:52:11 UTC


README

Shipping Label application

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

  • API version: v1
  • 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:

{
  "minimum-stability": "dev",
  "repositories": [
    {
      "type": "vcs",
      "url": "https://adhudasia@bitbucket.org/itembase/iws-isa.git"
    }
  ],
  "require": {
    "itembase/iws-isa": "master"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/SwaggerClient-php/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');


$apiInstance = new Swagger\Client\Api\AuthenticationApi(
    // 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 \Swagger\Client\Model\ShippingLabelAccessCredentials(); // \Swagger\Client\Model\ShippingLabelAccessCredentials | 
$instance_id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 
$test_mode = false; // bool | 

try {
    $result = $apiInstance->create($body, $instance_id, $test_mode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->create: ', $e->getMessage(), PHP_EOL;
}


$apiInstance = new Swagger\Client\Api\AuthenticationApi(
    // 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
);
$instance_id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 
$connection_id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 

try {
    $result = $apiInstance->remove($instance_id, $connection_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->remove: ', $e->getMessage(), PHP_EOL;
}


$apiInstance = new Swagger\Client\Api\AuthenticationApi(
    // 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 \Swagger\Client\Model\ShippingLabelUpdateCredentials(); // \Swagger\Client\Model\ShippingLabelUpdateCredentials | 
$instance_id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 
$connection_id = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 
$test_mode = false; // bool | 

try {
    $result = $apiInstance->update($body, $instance_id, $connection_id, $test_mode);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuthenticationApi->update: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://st01.api.itembase.com/connectivity

Class Method HTTP request Description
AuthenticationApi create POST /instances/{instanceId}/connections/shipping/auth/v2 Create a connection
AuthenticationApi remove DELETE /instances/{instanceId}/connections/{connectionId}/shipping/auth/v2 Removes a connection
AuthenticationApi update PUT /instances/{instanceId}/connections/{connectionId}/shipping/auth/v2 Update the connection
HarmonizedSystemCodesApi getHsCodes POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/hs Get Hs codes for list of products
HarmonizedSystemCodesApi isClassified POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/hs/classificationstatus Check products classification status
LinnworksApi addUser POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/addUser Add User
LinnworksApi callEmpty POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/empty**/** Empty handler
LinnworksApi cancelLabel POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/label/cancel Cancel label
LinnworksApi createLabel POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/label/create Create label
LinnworksApi getAvailableServices POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/availableServices Get available services
LinnworksApi getExternalPropertiesMap POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/ExtPropertyMap Get Extended Property mapping
LinnworksApi getUserConfig POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/userConfig Get User Config
LinnworksApi updateUserConfig POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/userConfig/update Update User Config
LinnworksApi updateUserConfig1 POST /instances/{instanceId}/connections/shipping/api/v2/extint/linnworks/userConfig/delete Delete User
LocationsApi getLocations GET /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/locations Get Locations
ShipmentInfoApi orderShipmentInfo POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/shipment/order/info Get Order Shipment Info
ShipmentInfoApi trackShipment GET /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/shipment/track Track Shipment
ShippingLabelApi cancelShippingLabel DELETE /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/label Cancel Shipping Label
ShippingLabelApi createShippingLabel POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/label Create Shipping Label
ShippingLabelApi getShippingLabel GET /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/label Get Shipping Label
ShippingRateApi getShippingRate POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/rate Get Shipping Rate
ShippingServicesApi getServices GET /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/services Get Shipping Services
ShoplineApi getRates POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/extint/shopline/rates Get Rates
TaxAndDutiesApi getQuotes POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/tad/quotes Get Taxes and Duties quotes
TaxAndDutiesApi submitParcel POST /instances/{instanceId}/connections/{connectionId}/shipping/api/v2/tad/submitOrder Submit parcel

Documentation For Models

Documentation For Authorization

bearer-jwt

  • Type: HTTP bearer authentication

Author