Orders

Introduction

For how to handle the exceptions correctly, see Exceptions.

Index

The OrderService->get() method can extract all Order models.

The OrderService->include() method extracts model relation values.

use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client = new Client(self::KEY, self::URL);
$service = new OrderService($client);

$orders = $service->include(
    OrderIncludes::BILLING,
    OrderIncludes::COMMENTS,
    OrderIncludes::DISCOUNTS,
    OrderIncludes::ITEMS,
    OrderIncludes::PAYMENT,
    OrderIncludes::TAGS,
    OrderIncludes::TAXES,
)->get();

Show

The OrderService->find() method can extract a single Order model.

The OrderService->include() method extracts model relation values.

use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service->include(
    OrderIncludes::BILLING,
    OrderIncludes::COMMENTS,
    OrderIncludes::DISCOUNTS,
    OrderIncludes::ITEMS,
    OrderIncludes::PAYMENT,
    OrderIncludes::TAGS,
    OrderIncludes::TAXES,
)->find(1);

$amount        = $order->amount();
$amountWithTax = $order->amountWithTax();
$createdAt     = $order->createdAt();
$deletedAt     = $order->deletedAt();
$id            = $order->id();
$invoiceNumber = $order->invoiceNumber();
$invoiceStatus = $order->invoiceStatus()->value;
$isFirst       = $order->isFirst();
$isHidden      = $order->isHidden();
$taxExempt     = $order->taxExempt()->value;
$mode          = $order->mode()->value;
$reference     = $order->reference();
$source        = $order->source()->value;
$updatedAt     = $order->updatedAt();

Store Order

The OrderService->create() method can store a single Order model to the Plug and Pay dashboard.

use \PlugAndPay\Sdk\Entity\Address;
use \PlugAndPay\Sdk\Entity\Billing;
use \PlugAndPay\Sdk\Entity\Comment;
use \PlugAndPay\Sdk\Entity\Contact;
use \PlugAndPay\Sdk\Entity\Item;
use \PlugAndPay\Sdk\Entity\Order;
use \PlugAndPay\Sdk\Entity\Payment;
use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Enum\PaymentStatus;
use \PlugAndPay\Sdk\Enum\TaxExempt;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client = new Client($token);
$service = new OrderService($client);

$taxRate = (new TaxRate)
    ->setCountry(CountryCode::NL)
    ->setPercentage(21);

$tax = (new Tax())
    ->setAmount(21)
    ->setRate($taxRate);

$payment = (new Payment)
    ->setCustomerId('asdasd')
    ->setMandateId('asdasdas')
    ->setMethod(PaymentMethod::APPLEPAY)
    ->setOrderId(1)
    ->setPaidAt(new DateTimeImmutable('2022-01-01'))
    ->setProvider(PaymentProvider::MOLLIE)
    ->setStatus(PaymentStatus::PAID)
    ->setTransactionId('123456-mollie')
    ->setType(PaymentType::MANUAL)
    ->setUrl('https://www.cool-item.com');

$discount = (new Discount())
    ->setAmount(10)
    ->setCode('123456-discount-code')
    ->setType(DiscountType::PROMOTION);

$itemOne = (new Item())
    ->setProductId(1)
    ->setAmount(100)
    ->setTotal(121)
    ->setDiscounts([$discount]);

$itemTwo = (new Item())
    ->setProductId(2)
    ->setAmount(242)
    ->setTotal(121)
    ->setDiscounts([$discount]);

$contact = (new Contact())
    ->setCompany('IMU')
    ->setEmail('testing@plugandpay.nl')
    ->setFirstName('test')
    ->setLastName('the tester')
    ->setTelephone('06-81945028')
    ->setWebsite('https://www.plugandpay.nl');

$address = (new Address())
    ->setCity('Amersfoort')
    ->setCountry(CountryCode::NL)
    ->setStreet('teststreet')
    ->setHouseNumber('230-1')
    ->setZipcode('2323DD');

$commentOne = (new Comment())->setValue('Comment One');
$commentTwo = (new Comment())->setValue('Comment Two');

$billing = (new OrderBilling())
    ->setAddress($address)
    ->setContact($contact);

$order = (new Order)
    ->setAmount(100)
    ->setTotal(121)
    ->setBilling($billing)
    ->setComments([
        $commentOne,
        $commentTwo,
    ])
    ->setTotalDiscounts([$discount])
    ->setHidden(false)
    ->setItems([
        $itemOne,
        $itemTwo,
    ])
    ->setMode(Mode::TEST)
    ->setPayment($payment)
    ->setReference('123456789')
    ->setSource(Source::API)
    ->setTags([
        'first',
        'second',
        'third',
        'fourth',
    ])
    ->setTaxExempt(TaxExempt::NONE)
    ->setTaxes([$tax])
    ->setCreatedAt(new DateTimeImmutable('2021'));

$order = $service->include(
    OrderIncludes::BILLING,
    OrderIncludes::COMMENTS,
    OrderIncludes::DISCOUNTS,
    OrderIncludes::ITEMS,
    OrderIncludes::PAYMENT,
    OrderIncludes::TAGS,
    OrderIncludes::TAXES,
)->create($order);

$orderId = $order->id();

Update Order

The OrderService->update() method can update a single Order model to the Plug and Pay dashboard.

use \PlugAndPay\Sdk\Entity\Order;
use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client = new Client($token);
$service = new OrderService($client);

$order = $service->include(
    OrderIncludes::BILLING,
    OrderIncludes::COMMENTS,
    OrderIncludes::DISCOUNTS,
    OrderIncludes::ITEMS,
    OrderIncludes::PAYMENT,
    OrderIncludes::TAGS,
    OrderIncludes::TAXES,
)->update(14, function (Order $order) {
    $order->setAmount(1000.00);
    $order->setTotal(1210.00);

    // Billing Address
    $order->billing()->address()->setCity('Utrecht');
    $order->billing()->address()->setCountry(CountryCode::AL);
    $order->billing()->address()->setStreet('Sesamstraat');
    $order->billing()->address()->setHouseNumber('123');
    $order->billing()->address()->setZipcode('123');

    // Billing Contact
    $order->billing()->contact()->setCompany('New Company');
    $order->billing()->contact()->setEmail('new@plugandpay.nl');
    $order->billing()->contact()->setFirstName('First');
    $order->billing()->contact()->setLastName('Last');
    $order->billing()->contact()->setTelephone('0612345678');
    $order->billing()->contact()->setWebsite('https://www.new-website.com');

    $order->setFirst(false);
    $order->setHidden(true);
    $order->setMode(Mode::LIVE);
    $order->setReference('new-reference-123');
    $order->setTaxExempt(TaxExempt::REVERSE);
});

Destroy Order

The OrderService->delete() method can delete a single Order model from the Plug and Pay dashboard.

On success: nothing is returned Not found: NotFoundException exception is thrown Not authenticated: UnauthenticatedException exception is thrown

use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$service->delete(12);

Filter

use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;
use \PlugAndPay\Sdk\Filters\OrderFilter;

$client  = new Client($token);
$service = new OrderService($client);

$orders = $service->get(function(OrderFilter $filter) {
    $filter
      ->affiliateId(1234)
      ->checkoutId(1234)
      ->contractId(1234)
      ->contractType(\PlugAndPay\Sdk\Enum\ContractType::SUBSCRIPTION)
      ->country(\PlugAndPay\Sdk\Enum\CountryCode::from('NL'))
      ->direction(\PlugAndPay\Sdk\Enum\Direction::DESC)
      ->discountCode('sale123')
      ->email('maarten.veenstra@example.net')
      ->hasBump(true)
      ->hasTax(true)
      ->invoiceStatus(\PlugAndPay\Sdk\Enum\InvoiceStatus::FINAL)
      ->isDeleted(true)
      ->isFirst(true)
      ->isHidden(true)
      ->isUpsell(true)
      ->limit(1)
      ->mode(\PlugAndPay\Sdk\Enum\OrderMode::LIVE)
      ->page(2)
      ->paymentStatus(\PlugAndPay\Sdk\Enum\PaymentStatus::PAID)
      ->productId(1234)
      ->productTag('color-blue')
      ->query('Piet Niet')
      ->sinceInvoiceDate(new DateTime())
      ->sincePaidAt(new DateTime())
      ->sort(\PlugAndPay\Sdk\Enum\OrderSortType::PAID_AT)
      ->source(\PlugAndPay\Sdk\Enum\OrderSource::API)
      ->untilInvoiceDate(new DateTime())
      ->untilPaidAt(new DateTime());
});

Extra Information

By using the include method you can get more information. It is important that you only request the information you need.

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$service
    ->include(
        OrderIncludes::BILLING,
        OrderIncludes::COMMENTS,
        OrderIncludes::DISCOUNTS,
        OrderIncludes::ITEMS,
        OrderIncludes::PAYMENT,
        OrderIncludes::TAGS,
        OrderIncludes::TAXES,
    )
    ->find(1);

Billing

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service
    ->include(\PlugAndPay\Sdk\Enum\OrderIncludes::BILLING)
    ->find(1);

$billing = $order->billing();

$company     = $billing->company();
$email       = $billing->email();
$firstName   = $billing->firstName();
$lastName    = $billing->lastName();
$telephone   = $billing->telephone();
$website     = $billing->website();
$city        = $billing->address()->city();
$country     = $billing->address()->country()->value;
$street      = $billing->address()->street();
$houseNumber = $billing->address()->houseNumber();
$zipcode     = $billing->address()->zipcode();

Comments

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service
    ->include(\PlugAndPay\Sdk\Enum\OrderIncludes::COMMENTS)
    ->find(1);

$comment = $order->comments()[0];

$createdAt = $comment->createdAt();
$id        = $comment->id();
$updatedAt = $comment->updatedAt();
$value     = $comment->value();

Discount

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service
    ->include(\PlugAndPay\Sdk\Enum\OrderIncludes::DISCOUNTS)
    ->find(1);

$discount = $order->totalDiscounts()[0];
// Or receive a discount from an item:
$discount = $order->items()[0]->discounts()[0];

$value    = $discount->amount();
$code     = $discount->code();
$type     = $discount->type()->value;

Items

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service
    ->include(\PlugAndPay\Sdk\Enum\OrderIncludes::ITEMS)
    ->find(1);

$item = $order->items()[0];

$discount      = $item->discounts()[0]->amount();
$discountCode  = $item->discounts()[0]->code();
$id            = $item->id();
$label         = $item->label();
$productId     = $item->productId();
$quantity      = $item->quantity();
$amount        = $item->amount();
$amountWithTax = $item->amountWithTax();
$amountWithTax = $item->type()->value;

Payment

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service
    ->include(\PlugAndPay\Sdk\Enum\OrderIncludes::PAYMENT)
    ->find(1);

$payment = $order->payment();

$customerId    = $payment->customerId();
$mandateId     = $payment->mandateId();
$method        = $payment->method()->value;
$orderId       = $payment->orderId();
$paidAt        = $payment->paidAt();
$provider      = $payment->provider()->value;
$status        = $payment->status()->value;
$transactionId = $payment->transactionId();
$type          = $payment->type()->value;
$url           = $payment->url();

Tags

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service
    ->include(OrderIncludes::TAGS)
    ->find(1);

$tags = $order->tags();

Taxes

use \PlugAndPay\Sdk\Enum\OrderIncludes;
use \PlugAndPay\Sdk\Service\Client;
use \PlugAndPay\Sdk\Service\OrderService;

$client  = new Client($token);
$service = new OrderService($client);

$order = $service
    ->include(OrderIncludes::TAXES)
    ->find(1);

// All taxes
$tax = $order->taxes()[0];
$tax->amount()
$tax->rate()->percentage()

// Tax per item
$item              = $order->items()[0];
$itemTaxValue      = $item->tax()->amount();
$itemTaxPercentage = $item->tax()->rate()->percentage();