zvps/royal-mail-click-and-drop-rest-api-client

v1.4 2021-10-20 21:18 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~2.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Swagger and contributors
• zVPS.uk

• php
• api
• sdk
• swagger

README

Import your orders, retrieve your orders and generate labels.

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

• API version: 1.0.0
• Build package: io.swagger.codegen.languages.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/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:

    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');

// Configure API key authorization: Bearer
$config = RoyalMail\ClickAndDrop\Rest\Api\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = RoyalMail\ClickAndDrop\Rest\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new RoyalMail\ClickAndDrop\Rest\Api\LabelsApi(
    // 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
);
$orderIdentifiers = "orderIdentifiers_example"; // string | Order Identifier or several Order Identifiers separated by semicolon
$documentType = "documentType_example"; // string | Document generation mode. When documentType is set to \"postageLabel\" the additional parameters below must be used. These additional parameters will be ignored when documentType is not set to \"postageLabel\"
$includeReturnsLabel = true; // bool | Include returns label. Required when documentType is set to 'postageLabel'
$includeCN = true; // bool | Include CN22/CN23 with label. Optional parameter. If this parameter is used the setting will override the default account behaviour specified in the \"Label format\" setting \"Generate customs declarations with orders\"

try {
    $result = $apiInstance->getOrdersLabelAsync($orderIdentifiers, $documentType, $includeReturnsLabel, $includeCN);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LabelsApi->getOrdersLabelAsync: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.parcel.royalmail.com/api/v1

Class	Method	HTTP request	Description
LabelsApi	getOrdersLabelAsync	GET /orders/{orderIdentifiers}/label	Return a single PDF file with generated label and/or associated document(s)
OrdersApi	createOrdersAsync	POST /orders	Create orders
OrdersApi	getOrdersAsync	GET /orders/{orderIdentifiers}	Retrieve orders
OrdersApi	getOrdersWithDetailsAsync	GET /orders/{orderIdentifiers}/full	Retrieve orders details
VersionApi	getVersionAsync	GET /version	Get API version details.

Documentation For Models

• AddressRequest
• BillingDetailsRequest
• CreateOrderErrorResponse
• CreateOrderRequest
• CreateOrderResponse
• CreateOrdersRequest
• CreateOrdersResponse
• DimensionsRequest
• ErrorResponse
• FailedOrderResponse
• GetOrderDetailsResource
• GetOrderInfoResource
• GetOrderLineResult
• GetPostalDetailsResult
• GetShippingDetailsResult
• GetTagDetailsResult
• GetVersionResource
• LabelGenerationRequest
• OrderFieldResponse
• PostageDetailsRequest
• ProductItemRequest
• RecipientDetailsRequest
• SenderDetailsRequest
• ShipmentPackageRequest
• TagRequest

Documentation For Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author