README

API for creating, updating, canceling shipments and generating labels for GO! Express & Logistics.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure HTTP basic authorization: basicAuth
$config = kruegge82\goexpress\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new kruegge82\goexpress\Api\DefaultApi(
    // 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
);
$label_request = new \kruegge82\goexpress\Model\LabelRequest(); // \kruegge82\goexpress\Model\LabelRequest

try {
    $apiInstance->labelApiV1GenerateLabelForhwbPost($label_request);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->labelApiV1GenerateLabelForhwbPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://ws.api.general-overnight.com/external/ci

Class	Method	HTTP request	Description
DefaultApi	labelApiV1GenerateLabelForhwbPost	POST /label/api/v1/generateLabelForhwb	Generate label for existing HWB
DefaultApi	orderApiV1CreateOrderPost	POST /order/api/v1/createOrder	Create or update shipment order
DefaultApi	orderApiV1UpdateOrderStatusPost	POST /order/api/v1/updateOrderStatus	Update order status

Models

Authorization

Authentication schemes defined for the API:

basicAuth

Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.0
- Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

kruegge82 / goexpress

Maintainers

Details