Create Receipt for Shipment

Overview

The Create Receipt for Shipment step issues a receipt for each delivered shipment of an order paid through a payment provider, such as Klarna, Vipps or Adyen. A receipt is the paid sales document for one shipment: it lists the delivered order lines, the shipping cost, the VAT per rate and the payments that paid for the shipment. An order with three shipments gets three receipts.

Omnium stores a receipt as an invoice with the invoice type Receipt. Your webshop or customer portal reads the receipts of an order and downloads each one as a PDF through the Invoices API.

The step issues the receipt when the goods are delivered, not when the payment is captured. Place it after Capture Payments in the status where the shipment is shipped or picked up. The Fulfill - Complete shipment and capture payment workflow group template includes the step after Capture Payments.

Identifier

Configuration Properties

Behavior

What It Does

1. Selects the shipments to issue receipts for:

   • At shipment level: the shipment the workflow runs for
   • At order level: every shipment of the order that is not cancelled. The step does not check whether a shipment has shipped, so at order level, run it only in a status where every shipment is delivered.

2. Skips a shipment that:

   • Was paid at the POS and already has a POS receipt
   • Already has a receipt, or an invoice for that shipment, such as one from the Create Invoice step
   • Has no delivered lines and a total of 0
   • Was paid with the store's own invoice, the OmniumInvoice payment method, as that invoice is its sales document
   • Was paid with a payment method in ExcludedPaymentMethods

   For the last two, a payment counts when it was taken for the shipment or belongs to no shipment. A payment that failed or was voided does not count, so a customer who gave up on a method and paid with another one still gets a receipt.

3. Works out which payments paid the shipment:

   • The payments captured for the shipment
   • A share of the payments that belong to no shipment, such as a gift card or bonus used at checkout or a payment captured at checkout, less what earlier receipts on the order already used
   • Invoiced payments do not count, because the customer has not paid them yet

4. Issues no receipt for a shipment that is not fully paid, and adds an order error instead

5. Issues the receipt with a number from the receipt number series, and records its ID on the shipment

What the Receipt Contains

The receipt PDF has the title RECEIPT, translated to the market language (KVITTERING in Norwegian). It shows a paid line that names the payment methods instead of the due date, KID and bank account, the delivery date and the shipment, the payments, a VAT rate column on the lines, and a VAT summary per rate. To change the layout, choose an invoice template for the market.

Put the seller details that a sales document must show, such as the legal company name and organization number, in the store's or market's document footer. A receipt keeps the footer it was issued with, so a later change to the footer does not change receipts that already exist. A receipt issued while no footer was set shows the current store or market footer.

Orders Paid with a Provider's Invoice

A shipment paid with a payment provider's invoice or part payment, such as Klarna's, gets a receipt when the provider captures the payment. The provider settles the order with the store, and the customer pays the provider later. The paid line names the provider, so the customer can see that the provider's invoice is for the same purchase.

A shipment paid with the store's own invoice gets no receipt. Use Create Invoice for those orders.

Emailing the Receipt

The step does not send an email itself. To email the receipt, select the Receipt for the shipment attachment on the order notification the customer gets when the goods are sent or picked up. The email then carries the receipt PDF of the shipment it is about, or of every shipment that has a receipt when the email is for the whole order. An email for a shipment without a receipt has no receipt attached.

The order notification builds its email when the Notification step runs, so place Create Receipt for Shipment before Notification in the same status. When the receipt is attached, turn off the Copy of receipt attachment on the same notification. That attachment is a printout of the whole order, not the numbered receipt.

Receipt Number Series

The step takes the receipt number from the ReceiptNumberOptions number series of the order's market or tenant. Without a receipt series it uses the InvoiceNumberOptions series. A receipt must have a number from a series, so the step issues no receipt when neither series is configured with a service other than GuidNumberService. See Number Options.

Prerequisites

• The tenant has access to Invoices
• A ReceiptNumberOptions or InvoiceNumberOptions number series is configured with a service other than GuidNumberService
• The payments are captured, usually by Capture Payments earlier in the same status

Side Effects

• Creates one invoice of the type Receipt per issued shipment
• Sets the external ID OmniumReceiptId on the shipment to the receipt ID
• Logs an invoice event for each receipt, which event subscriptions can deliver as a webhook
• Adds the order error Receipt not issued when a shipment could not get a receipt, and removes it on a later run in which no shipment fails or is left not fully paid

Business Cases

When to Use

• Receipts in the webshop: Show the customer a paid sales document for each delivery
• Orders paid through a payment provider: The provider handles the payment, and Omnium issues the sales document
• Split deliveries: Give each shipment its own receipt with only the lines it delivered

Example Scenarios

Scenario 1: Klarna order in two shipments The first shipment ships and Capture Payments captures 1,499.00 for it. The step issues receipt K-10234 for that shipment. The second shipment ships a week later and gets receipt K-10235.

Scenario 2: Gift card used at checkout The customer pays 300.00 with a gift card and the rest with Klarna. The first shipment of 200.00 takes 200.00 of the gift card. The second shipment of 500.00 takes the remaining 100.00 of the gift card and 400.00 captured from Klarna.

Scenario 3: Marketplace orders The store sells on a marketplace that issues the sales documents for the store, and the orders carry the payment method Zalando. With ExcludedPaymentMethods set to Zalando, those shipments get no receipt and the order gets no error, while webshop orders get their receipts as before.

Scenario 4: Shipment not fully paid The capture for a shipment failed, so the payments do not cover the shipment total. The step issues no receipt, adds the order error and tags the order with the ErrorTag value. When the shipment is paid, the step issues the receipt the next time it runs for the shipment.

Error Handling

An error does not stop the workflow, because the goods are delivered whether or not the receipt could be issued.

Related Steps

• Capture Payments - Captures the payments the receipt lists
• Create Invoice - Creates an invoice the customer pays later
• Create Credit Note - Credits the receipts that hold returned lines