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

Class	Method	HTTP request	Description
CapturesApi	appendShippingInfo	POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/shipping-info	Add shipping information
CapturesApi	captureOrder	POST /ordermanagement/v1/orders/{order_id}/captures	Capture an order
CapturesApi	extendDueDate	PATCH /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date	Extend payment due date
CapturesApi	getCapture	GET /ordermanagement/v1/orders/{order_id}/captures/{capture_id}	Get capture details
CapturesApi	getCaptures	GET /ordermanagement/v1/orders/{order_id}/captures	List all order captures
CapturesApi	getOptionsForExtendDueDate	GET /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date-options	List options for extension of payment due date
CapturesApi	triggerSendOut	POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-out	Send customer communication
OrdersApi	acknowledgeOrder	POST /ordermanagement/v1/orders/{order_id}/acknowledge	Acknowledge a Klarna checkout order
OrdersApi	appendOrderShippingInfo	POST /ordermanagement/v1/orders/{order_id}/shipping-info	Add shipping information
OrdersApi	cancelOrder	POST /ordermanagement/v1/orders/{order_id}/cancel	Cancel an order
OrdersApi	extendAuthorizationTime	POST /ordermanagement/v1/orders/{order_id}/extend-authorization-time	Extend the authorization time
OrdersApi	getOrder	GET /ordermanagement/v1/orders/{order_id}	Get order details
OrdersApi	releaseRemainingAuthorization	POST /ordermanagement/v1/orders/{order_id}/release-remaining-authorization	Release an authorization
OrdersApi	updateAuthorization	PATCH /ordermanagement/v1/orders/{order_id}/authorization	Update the order amount and order lines
OrdersApi	updateConsumerDetails	PATCH /ordermanagement/v1/orders/{order_id}/customer-details	Update customer addresses
OrdersApi	updateMerchantReferences	PATCH /ordermanagement/v1/orders/{order_id}/merchant-references	Update merchant references
RefundsApi	get	GET /ordermanagement/v1/orders/{order_id}/refunds/{refund_id}	Get refund details
RefundsApi	refundOrder	POST /ordermanagement/v1/orders/{order_id}/refunds	Refund an order

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

tuutti/php-klarna-ordermanagement

包简介

关键字：

README 文档