OTTO Market API documentation



Important: The new version v2 is released now! Please use v2.

We plan to go offline with this version 1 (v1) earliest by 14th October 2020.

Receipts Interface

Once a customer places an order and the shipment has gone through or when a customer returns a product and the return is accepted by the partner, a financial transaction takes place and OTTO generates a receipt.

One order can be fulfilled by multiple shipments and each Shipment will have a receipt. This receipt contains Customer Information, Article Information, Total Price including Shipping charges (if any), Payment Details/Refund Details, Receipt Details, Partner Information.

This receipt is available for the customer to view on the "mein Rechnung" page and this receipt is also available to the partner. The following are two ways from where the partner can get access to these receipts:

      1. OPC portal
      2. Receipts API

Changelog

This changelog will document all relevant changes in our interface. Kudos to https://keepachangelog.com/de/1.0.0/

2020-07-15

Changed

  • Legally compliant and human readable receipt number is introduced during this day. Receipt numbers already generated are not affected by this change. There should be no overlapping of previous numbers. There are no changes in the definition of the fields.

2020-07-01

Changed

  • If the temporary reduction of VAT rates is decided, we will take this into account when calculating customer receipts. Structural changes to the interface are not required. However, we would like to inform you that there may be changed combinations in the total vat values. In principle, it is also possible that 16% and 19% are displayed together on refund receipts.

2020-03-23

Changed

  • districtCourt and registerNumber in the partner information are not guaranteed

2020-02-27

Changed

  • Customer address on refund receipts will be the current customer address

2020-02-25

Changed

  • Delivery address will only be populated for purchase receipts in the next version

2019-12-09

Changed

  • Description and examples of few fields
  • Total values of all kinds of refund receipts will be positive in next version. In current versions these values have a negative sign.

Deprecated

The following fields will be deleted completely in next version

  • receiptID
  • originalReceiptID
  • returnDate
  • transactionId
  • partner.id
  • customer.customerId
  • customer.uniqueUserId
  • lineItem.productId
  • lineItem.variationId
  • lineItem.partnerVariationId
  • payment

The following fields will be replaced by another field in next version

  • partner.country -> partner.countryCode
  • customer.country -> customer.countryCode
  • deliveryAddress.country-> deliveryAddress.countryCode
  • lineItem.salesOrderPositionItemIds -> lineItem.positionItemIds

The following endpoints will be replaced by another endpoints in next version

  • /v1/receipts/{receiptNumber}/pdf -> /v2/receipts/{receiptNumber}.pdf

Status: Released

2019-11-04

Added

  • Introduced /v1/receipts/{receiptNumber} endpoint to get a specific receipts in JSON format
  • Enriched /v1/receipts endpoint with several query filters. This filters are noted below
  • customer_id
  • sales_order_id
  • type
  • Use 128 as default limit for /v1/receipts
  • Add partner's headOfSupervisoryBoard information in response

2019-10-14

Added

  • the following endpoints
  • Add /v1/receipts
  • Add /v1/receipts/{receiptNumber}/pdf
Imprint | Privacy policy | Datenschutz