Receipts V3

Get the JSON object of a specific receipt

Get JSON object by the 'receiptNumber'

get/v3/receipts/{receiptNumber}

Path parameters

receiptNumberstring required

ReceiptNumber

Response

Successfully retrieved the receipt

receiptType'PURCHASE' | 'REFUND' | 'PARTIAL_REFUND' required

Categorisation that classifies the receipts according to the main characteristics

ATTENTION: In previous version the information was called type

isRealReceiptboolean required

Counterpart to the sentence "Dies ist kein Beleg/keine Rechnung im Sinne des Umsatzsteuergesetzes und berechtigt nicht zum Vorsteuerabzug." on pdf document.

Is set to true by default. Sentence is not printed.
Is set to false for technical receipts or if partner has to report VAT via the OSS procedure. The Sentence is printed.

isDeemedSupplierModelboolean required

Counterpart to the sentence "Die Umsatzsteuer wird von der OTTO GmbH & Co. KGaA abgeführt." on PDF document.

Is set to true if this receipt is subject to the deemed supplier regime; OTTO Market is liable for VAT. The sentence is printed.
Is set to false if this receipt is not subject to the deemed supplier regime; the partner is liable for VAT.

receiptNumberstring required

Human readable identifier of a receipt known by customer. Guaranteed to be unique per partner

creationDatestring date-time required

Date when receipt is created by system (UTC in ISO-8601 format)

fulfillmentDatestring date-time

Date when service fulfilled.

salesOrderIdstring required

Technical identifier of corresponding sales order

orderNumberstring required

Order number of corresponding sales order

orderDatestring date-time required

Order date of corresponding sales order (UTC in ISO-8601 format)

shipmentDatestring date-time

Date when physical items of this receipt were handed over to the carrier to be delivered to the customer (UTC in ISO-8601 format).Only available on receipts of receiptType PURCHASE.

linkedReceiptNumberstring

Human-readable identifier of linked receipt. In case of receiptType PARTIAL_REFUND or REFUND it is the receiptINumber of purchase receipt.

ATTENTION: In previous version the information was called originalReceiptNumber

linkedCreationDatestring date-time

Creation date of linked receipt (UTC in ISO-8601 format).Only available if there is a linked receipt.

ATTENTION: In previous version the information was called originalCreatedDate

refundType'RETURN' | 'CANCELLATION' | 'SERVICE_FULL_REFUND_CANCELLED_BY_SDU' | 'SERVICE_FULL_REFUND_CANCELLED_BY_CUSTOMER' | 'SERVICE_FULL_REFUND_PRODUCT_RETURNED'

Field describes the business case of a refund in more detail. Only available on receipts of receiptType REFUND and not reliable provided on older partial refund receipts.

The following refundTypes are possible:

RETURN - Refund due to a return of an item
CANCELLATION - Refund of delivery fees due to a cancellation
SERVICE_FULL_REFUND_CANCELLED_BY_SDU - Refund for service only, following service partner (SDU) cancellation
SERVICE_FULL_REFUND_CANCELLED_BY_CUSTOMER- Refund for service only, following customer cancellation
SERVICE_FULL_REFUND_PRODUCT_RETURNED - Refund for service only, following product return

partialRefundType'REFUND_COMPLAINT_ITEM' | 'REFUND_PAYPAL_DISPUTE' | 'REFUND_ESCALATION' | 'REFUND_PARTIAL_AMOUNT_AFTER_SERVICE_CANCELLATION' | 'REFUND_CREDIT_CARD_DISPUTE'

Business case of partial refund chosen by partner. Has an impact on the business flow and the PDF. Only available on receipts of receiptType PARTIAL_REFUND and not reliable provides on older partial refunds receipts.

Possible values:

REFUND_COMPLAINT_ITEM - Refund because of justified customer complaint on item
REFUND_PAYPAL_DISPUTE - Partial or full amount of item price was refunded due to a dispute in Paypal payment
REFUND_ESCALATION - Partial amount of item price was refunded due to an escalation
REFUND_PARTIAL_AMOUNT_AFTER_SERVICE_CANCELLATION - Lowering of service price after service was not fulfilled completely
REFUND_CREDIT_CARD_DISPUTE - Partial or full amount of item price was refunded due to a dispute in CREDIT_CARD payment

Example response

{
  "receiptType": "REFUND",
  "isRealReceipt": true,
  "isDeemedSupplierModel": true,
  "receiptNumber": "E-DE-123456789-2020-7",
  "salesOrderId": "80ec6483-4d53-44d8-9ba7-e846ab24da38",
  "orderNumber": "1224567",
  "shipment": {
    "shipFromAddress": {
      "zipCode": "60437",
      "countryCode": "DEU"
    }
  },
  "linkedReceiptNumber": "R-DE-123456789-2020-1507",
  "payment": {
    "paymentProvider": "OTTOPAYMENTS",
    "paymentMethod": "CREDIT_CARD_ONLINE",
    "installmentCount": 3
  },
  "partner": {
    "partnerName": "Funky Staff GmbH & Co. KG",
    "street": "Berner Straße 109",
    "zipCode": "60437",
    "city": "Hamburg",
    "countryCode": "DEU",
    "vatId": "DE215947224",
    "representedBy": "Monika Sievers, Paul Ackermann",
    "registerCourt": "Amtsgericht Hamburg",
    "commercialRegisterNumber": "HRB 5433221",
    "headOfSupervisoryBoard": "Hugo Steiner",
    "shopName": "Fun-Shop"
  },
  "customer": {
    "invoiceAddress": {
      "firstName": "Iris",
      "lastName": "Muster",
      "street": "Washingtonallee",
      "houseNumber": "42",
      "addition": "Hinterhof, 1. Stock",
      "zipCode": "22885",
      "city": "Bremerhaven",
      "countryCode": "DEU"
    }
  },
  "deliveryAddress": {
    "firstName": "Iris",
    "lastName": "Muster",
    "street": "Washingtonallee",
    "houseNumber": "42",
    "addition": "Hinterhof, 1. Stock",
    "zipCode": "22885",
    "city": "Bremerhaven",
    "countryCode": "DEU"
  },
  "lineItems": {
    "itemPositions": [
      {
        "lineNumber": 1,
        "sku": "123e4567-e89b-12d3-a456-426652340000",
        "expectedPerformancePeriod": "Nach Zahlung wird die Lieferung vorbereitet.",
        "articleNumber": "S081B05AP2",
        "productTitle": "Bobux »Baby Halbschuhe DIMENSION II für Mädchen« Schnürschuh",
        "variationAttributes": "Weiß, 19",
        "positionItemIds": [
          "476bb1ac-a227-4710-8ee4-f297a38a309c",
          "34gfb1ac-4f45-4710-4ef4-t555a38a309g"
        ],
        "quantity": 2,
        "unitPrice": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        },
        "priceToPayPerPositionItems": [
          {
            "positionItemIds": [
              "476bb1ac-a227-4710-8ee4-f297a38a309c",
              "34gfb1ac-4f45-4710-4ef4-t555a38a309g"
            ],
            "priceToPay": {
              "taxType": "VAT",
              "taxRate": "19.0",
              "gross": {
                "amount": 209.82,
                "currency": "EUR"
              },
              "net": {
                "amount": 174.85,
                "currency": "EUR"
              },
              "tax": {
                "amount": 34.97,
                "currency": "EUR"
              }
            }
          }
        ],
        "positionSum": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        },
        "priceModifications": [
          {
            "lineNumber": 1,
            "priceModificationType": "PARTNER_DISCOUNT",
            "details": {
              "description": "1 € Rabatt",
              "id": "82ffff8f-8709-4060-bcd3-ebdabbbc6514",
              "linkedReceiptNumber": "E-DE-123456789-2020-7",
              "linkedReceiptCreationDate": "2022-06-30T14:35:00.221Z",
              "type": "PARTNER_DISCOUNT",
              "reason": "GOODWILL_ITEM_REFUND_REJECTED",
              "linkedPositionItemId": "d76533b7-9c98-4be5-97a2-c54ba1929b33"
            },
            "priceModificationAmount": {
              "taxType": "VAT",
              "taxRate": "19.0",
              "gross": {
                "amount": 209.82,
                "currency": "EUR"
              },
              "net": {
                "amount": 174.85,
                "currency": "EUR"
              },
              "tax": {
                "amount": 34.97,
                "currency": "EUR"
              }
            }
          }
        ]
      }
    ],
    "itemPartialRefundPositions": [
      {
        "lineNumber": 3,
        "sku": "123e4567-e89b-12d3-a456-426652340000",
        "articleNumber": "S081B05AP2",
        "productTitle": "Bobux »Baby Halbschuhe DIMENSION II für Mädchen« Schnürschuh",
        "variationAttributes": "Weiß, 19",
        "positionItemIds": [
          "476bb1ac-a227-4710-8ee4-f297a38a309c"
        ],
        "partialRefundAmount": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        }
      }
    ],
    "servicePositions": [
      {
        "lineNumber": 3,
        "serviceType": "DISPOSAL",
        "serviceName": "48 Monate Langzeitgarantie Personal Care",
        "servicePositionItemIds": [
          "476bb1ac-a2277-4710-8ee4-f297a38a309c",
          "476bb1ac-a227-4710-8ee4-f297a38a309b"
        ],
        "linkedItemDetails": {
          "itemReceiptNumber": "R-DE-123456789-2020-715",
          "itemPartnerName": "Tonio Mertez e.K.",
          "sku": "123e4567-e89b-12d3-a456-426652340000",
          "articleNumber": "S081B05AP2",
          "productTitle": "Bobux »Baby Halbschuhe DIMENSION II für Mädchen« Schnürschuh",
          "serviceRelations": [
            {
              "servicePositionItemId": "476bb1ac-a2277-4710-8ee4-f297a38a309c",
              "positionItemId": "476bb1ac-a2277-4710-8ee4-f297a38a309b"
            }
          ]
        },
        "quantity": 2,
        "unitPrice": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        },
        "positionSum": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        },
        "priceModifications": [
          {
            "lineNumber": 1,
            "priceModificationType": "PARTNER_DISCOUNT",
            "details": {
              "description": "1 € Rabatt",
              "id": "82ffff8f-8709-4060-bcd3-ebdabbbc6514",
              "linkedReceiptNumber": "E-DE-123456789-2020-7",
              "linkedReceiptCreationDate": "2022-06-30T14:35:00.221Z",
              "type": "PARTNER_DISCOUNT",
              "reason": "GOODWILL_ITEM_REFUND_REJECTED",
              "linkedPositionItemId": "d76533b7-9c98-4be5-97a2-c54ba1929b33"
            },
            "priceModificationAmount": {
              "taxType": "VAT",
              "taxRate": "19.0",
              "gross": {
                "amount": 209.82,
                "currency": "EUR"
              },
              "net": {
                "amount": 174.85,
                "currency": "EUR"
              },
              "tax": {
                "amount": 34.97,
                "currency": "EUR"
              }
            }
          }
        ]
      }
    ],
    "servicePartialRefundPositions": [
      {
        "partialRefundAmount": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        }
      }
    ],
    "deliveryCosts": [
      {
        "lineNumber": 5,
        "deliveryCostType": "DELIVERY_FEE_STANDARD",
        "unitPrice": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        },
        "positionSum": {
          "taxType": "VAT",
          "taxRate": "19.0",
          "gross": {
            "amount": 209.82,
            "currency": "EUR"
          },
          "net": {
            "amount": 174.85,
            "currency": "EUR"
          },
          "tax": {
            "amount": 34.97,
            "currency": "EUR"
          }
        },
        "priceModifications": [
          {
            "lineNumber": 1,
            "priceModificationType": "PARTNER_DISCOUNT",
            "details": {
              "description": "1 € Rabatt",
              "id": "82ffff8f-8709-4060-bcd3-ebdabbbc6514",
              "linkedReceiptNumber": "E-DE-123456789-2020-7",
              "linkedReceiptCreationDate": "2022-06-30T14:35:00.221Z",
              "type": "PARTNER_DISCOUNT",
              "reason": "GOODWILL_ITEM_REFUND_REJECTED",
              "linkedPositionItemId": "d76533b7-9c98-4be5-97a2-c54ba1929b33"
            },
            "priceModificationAmount": {
              "taxType": "VAT",
              "taxRate": "19.0",
              "gross": {
                "amount": 209.82,
                "currency": "EUR"
              },
              "net": {
                "amount": 174.85,
                "currency": "EUR"
              },
              "tax": {
                "amount": 34.97,
                "currency": "EUR"
              }
            }
          }
        ]
      }
    ]
  },
  "totals": [
    {
      "taxType": "VAT",
      "taxRate": "19.0",
      "gross": {
        "amount": 209.82,
        "currency": "EUR"
      },
      "net": {
        "amount": 174.85,
        "currency": "EUR"
      },
      "tax": {
        "amount": 34.97,
        "currency": "EUR"
      }
    }
  ],
  "partialRefundType": "REFUND_COMPLAINT_ITEM",
  "amountDue": {
    "amount": 209.82,
    "currency": "EUR"
  },
  "totalsGrossAmount": {
    "amount": 209.82,
    "currency": "EUR"
  },
  "totalsReductions": [
    {
      "type": "VOUCHER",
      "details": {
        "voucherCode": "****EFGH"
      },
      "gross": {
        "currency": "EUR"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.