vismutx / klarna-order-management-api-php
Klarna order management api for PHP generated by swagger
1.06
2022-04-23 17:35 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2||^7.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
README
API to handle order lifecycle
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Build package: io.swagger.codegen.languages.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer run
composer require vismutx/klarna-order-management-api-php
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/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 HTTP basic authorization: basicAuth $config = Vismutx\KlarnaOrderManagementApiPhp\Configuration::getDefaultConfiguration() ->setUsername('YOUR_USERNAME') ->setPassword('YOUR_PASSWORD'); $apiInstance = new Vismutx\KlarnaOrderManagementApiPhp\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 ); $order_id = "order_id_example"; // string | Order id $capture_id = "capture_id_example"; // string | Capture id $body = new \Vismutx\KlarnaOrderManagementApiPhp\Model\UpdateShippingInfo(); // \Vismutx\KlarnaOrderManagementApiPhp\Model\UpdateShippingInfo | $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. try { $apiInstance->appendShippingInfo($order_id, $capture_id, $body, $klarna_idempotency_key); } catch (Exception $e) { echo 'Exception when calling CapturesApi->appendShippingInfo: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for 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 info to a capture |
CapturesApi | captureOrder | POST /ordermanagement/v1/orders/{order_id}/captures | Create capture |
CapturesApi | extendDueDate | PATCH /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date | Extend the customer's payment due date |
CapturesApi | getCapture | GET /ordermanagement/v1/orders/{order_id}/captures/{capture_id} | Get capture |
CapturesApi | getCaptures | GET /ordermanagement/v1/orders/{order_id}/captures | Get all captures for one order |
CapturesApi | getOptionsForExtendDueDate | GET /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/extend-due-date-options | Get available options for extension of the customer's payment due date |
CapturesApi | triggerSendOut | POST /ordermanagement/v1/orders/{order_id}/captures/{capture_id}/trigger-send-out | Trigger resend of customer communication |
OrdersApi | acknowledgeOrder | POST /ordermanagement/v1/orders/{order_id}/acknowledge | Acknowledge order |
OrdersApi | cancelOrder | POST /ordermanagement/v1/orders/{order_id}/cancel | Cancel order |
OrdersApi | extendAuthorizationTime | POST /ordermanagement/v1/orders/{order_id}/extend-authorization-time | Extend authorization time |
OrdersApi | getOrder | GET /ordermanagement/v1/orders/{order_id} | Get order |
OrdersApi | releaseRemainingAuthorization | POST /ordermanagement/v1/orders/{order_id}/release-remaining-authorization | Release remaining authorization |
OrdersApi | updateAuthorization | PATCH /ordermanagement/v1/orders/{order_id}/authorization | Set new 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 |
RefundsApi | refundOrder | POST /ordermanagement/v1/orders/{order_id}/refunds | Create a refund |
Documentation For 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
- Timeslot
- UpdateAuthorization
- UpdateConsumer
- UpdateMerchantReferences
- UpdateShippingInfo
Documentation For Authorization
basicAuth
- Type: HTTP basic authentication