README

The Order Management API is used for handling an order after the customer has completed the purchase. It is used for all actions you need to manage your orders. Examples being: updating, capturing, reading and refunding an order.

Read more on the Order management process.

Authentication

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/tuutti/php-klarna-ordermanagement.git"
    }
  ],
  "require": {
    "tuutti/php-klarna-ordermanagement": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/php-klarna-ordermanagement/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 = Klarna\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Klarna\OrderManagement\Api\CapturesApi(
    // 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
);
$capture_id = 'capture_id_example'; // string | Capture id
$order_id = 'order_id_example'; // string | Order id
$klarna_idempotency_key = 'klarna_idempotency_key_example'; // string | This header will guarantee the idempotency of the operation. The key should be unique and is recommended to be a UUID version 4. Retries of requests are safe to be applied in case of errors such as network errors, socket errors and timeouts. Input values of the operation are disregarded when evaluating the idempotency of the operation, only the key matters.
$update_shipping_info = new \Klarna\OrderManagement\Model\UpdateShippingInfo(); // \Klarna\OrderManagement\Model\UpdateShippingInfo

try {
    $apiInstance->appendShippingInfo($capture_id, $order_id, $klarna_idempotency_key, $update_shipping_info);
} catch (Exception $e) {
    echo 'Exception when calling CapturesApi->appendShippingInfo: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Models

• Addon
• Address
• CancelNotAllowedErrorMessage
• Capture
• CaptureNotAllowedErrorMessage
• CaptureObject
• CarrierProduct
• Customer
• ErrorMessageDto
• ExtendDueDateOptions
• ExtendDueDateRequest
• InitialPaymentMethodDto
• Location
• NoSuchCaptureErrorMessage
• NoSuchOrderErrorMessage
• NotAllowedErrorMessage
• NotFoundErrorMessage
• OptionDto
• Order
• OrderLine
• ProductIdentifiers
• Refund
• RefundNotAllowedErrorMessage
• RefundObject
• SelectedShippingOptionDto
• ShippingInfo
• Subscription
• Timeslot
• UpdateAuthorization
• UpdateConsumer
• UpdateMerchantReferences
• UpdateShippingInfo

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: 1.0
  • Generator version: 7.4.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen