README

About

With the JUMINGO shipping API you can import your shipments into your JUMINGO account from any source. The functionalities of the API include creating and updating shipment drafts, fetching suitable shipment rates for a given shipment and purchasing shipping labels. Furthermore, you can retrieve tracking data and fetch shipping labels and documents for all your purchased shipments.

The current main purpose of the API is to connect your account to e-commerce systems and marketplaces.

General

The API is organized around REST. Our API has resource-oriented URLs and uses HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs. All API requests must be made over HTTPS. Calls made over plain HTTP will return errors. Request data is passed to the API as JSON objects and JSON is also returned by all API responses, including errors, although our API SDKs convert requests and responses to appropriate language-specific objects.

Best practice usage of the API and business logic is described in the supplementary [integration guide](https://www.jumingo.com/cms/JUMiNGO_API-integration-guide.pdf "JUMiNGO API Integration Guide").

Base URL

The base URL for all calls is: https://api.jumingo.com/v1

HTTP status codes

HTTP response codes in the 2xx range indicate success. Codes in the 4xx range indicate an error on the client side (e.g. a required parameter is missing). Codes in the 5xx range indicate an error with our servers. Each error should provide an error code and an error message with further information.

HTTP status code	Description
200, 201, 204 - OK	Everything worked.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter or a validation error.
401 - Unauthorized	No valid API key has been provided or your account is disabled.
403 - Forbidden	You are not allowed to talk to this endpoint. This can either be due to a wrong authentication or when you’re trying to reach an endpoint that your account isn’t allowed to access.
404 - Not Found	The requested resource doesn’t exist.
500, 502, 503, 504 - Server Errors	Something went wrong on our side. Please contact our support if you receive this error.

Authentication

All API requests requires authentication. Unauthorized calls will return errors.

Authenticate by including your API key in the X-AUTH-TOKEN HTTP header of each API call, e.g.:

X-AUTH-TOKEN: INSERT_YOUR_API_KEY

You can find your API key in your JUMINGO user account. You can get access to the JUMiNGO customer API by enabling it in your user account. After activation, you will get your personal API key.

Date/Time Format

All values of type string <date-time> are defined in a specific RFC 3339 format and must also be formatted accordingly for requests.

The format is: YYYY-MM-DD hh:mm:ss

Example: 2018-07-26 15:54:13

All dates and times are specified in UTC (Coordinated Universal Time).

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 API key authorization: v1
$config = kruegge82\jumingo\Configuration::getDefaultConfiguration()->setApiKey('X-AUTH-TOKEN', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = kruegge82\jumingo\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-AUTH-TOKEN', 'Bearer');


$apiInstance = new kruegge82\jumingo\Api\CarrierApi(
    // 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
);
$access_point_search = new \kruegge82\jumingo\Model\V1CarrierAccessPointsSearchPostRequest(); // \kruegge82\jumingo\Model\V1CarrierAccessPointsSearchPostRequest

try {
    $result = $apiInstance->v1CarrierAccessPointsSearchPost($access_point_search);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CarrierApi->v1CarrierAccessPointsSearchPost: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.jumingo.com

Class	Method	HTTP request	Description
CarrierApi	v1CarrierAccessPointsSearchPost	POST /v1/carrier/access-points-search	Get carrier aaccess points by an address with some radius in kilometers
CartApi	postCartTotal	POST /v1/cart/total	Get cart total
ConnectionApi	createConnection	POST /v1/connections	Create a Connection
ConnectionApi	v1ConnectionsGet	GET /v1/connections	Retrieves the collection of Connection resources.
ConnectionApi	v1ConnectionsUuidGet	GET /v1/connections/{uuid}	Get the Connection
OrderApi	getAppOrderCollection	GET /v1/orders	Retrieves the collection of Order resources.
OrderApi	postOrders	POST /v1/orders	Make a payment.
OrderApi	v1OrdersIdDocumentsGet	GET /v1/orders/{id}/documents	Retrieves a OrderDocuments resource.
OrderApi	v1OrdersIdGet	GET /v1/orders/{id}	Retrieves a Order resource.
ShipmentApi	createShipment	POST /v1/shipments	Create a Shipment
ShipmentApi	getShipment	GET /v1/shipments/{shipment_id}	Retrieve a Shipment
ShipmentApi	getShipments	GET /v1/shipments	Get Shipments
ShipmentApi	patchV1ShipmentItem	PATCH /v1/shipments/{shipment_id}	Updates the Shipment resource.
ShipmentApi	updateShipmentRateCheapestTariffV1	POST /v1/shipments/cheapest	Update shipments rate
ShipmentApi	v1ShipmentsShipmentIdDelete	DELETE /v1/shipments/{shipment_id}	Removes the Shipment resource.
ShipmentApi	v1ShipmentsShipmentIdPut	PUT /v1/shipments/{shipment_id}	Replaces the Shipment resource.
ShipmentApi	v1ShipmentsUuidFileUploadTypeDelete	DELETE /v1/shipments/{uuid}/file/upload/{type}	Deletes a commercial invoice or an export declaration for a shipment
ShipmentApi	v1ShipmentsUuidFileUploadTypePost	POST /v1/shipments/{uuid}/file/upload/{type}	Uploads a commercial invoice or an export declaration for a shipment
ShipmentRateApi	v1ShipmentRatesPost	POST /v1/shipment-rates	Returns shipment rates for a given shipment.

Models

Authorization

Authentication schemes defined for the API:

v1

Type: API key
API key parameter name: X-AUTH-TOKEN
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

connections@jumingo.com

About this package

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

API version: 1.0.4
- Generator version: 7.19.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

kruegge82 / jumingo

Maintainers

Details