Marketplace API Usage

Learn about the specifics of marketplace use cases on Mondu's API

Order Creation

When creating orders as a marketplace vendor, be sure to transmit the vendor_external_reference_id in your order creation API request.

Single Vendor Basket

When an order is created with items that are shipped by a single vendor, you can submit the vendor_external_reference_id in the root of the API request payload.

Multi Vendor Basket

You can create one order with products from different vendors. In this case, the order should consist of multiple line objects, with the vendor_external_reference_id attached to each individual line.

👍

Good to Know

Our API validates the usage of vendor_external_reference_id. You can only submit it as part of the lines or as part of the order as a whole.

Code Examples

{
  "currency": "EUR",
  "billing_address": {
    "country_code": "DE",
    "city": "Berlin",
    "zip_code": "10179",
    "address_line1": "Alexanderstr. 36"
  },
  "shipping_address": {
    "country_code": "DE"
  },
  "buyer": {
    "email": "[email protected]",
    "first_name": "Max",
    "last_name": "Mustermann"
  },
  "lines": [
    {
      "line_items": [
        {
          "quantity": 1,
          "external_reference_id": "1",
          "title": "your-product",
          "net_price_per_item_cents": 8403,
          "net_price_cents": 8403,
          "tax_cents": 1597
        }
      ]
    }
  ],
  "external_reference_id": "your-order-ID",
  "vendor_external_reference_id": "your-vendor-id", // single vendor basket
  "gross_amount_cents": 10000,
  "payment_method": "invoice"
}
{
  "currency": "EUR",
  "billing_address": {
    "country_code": "DE",
    "city": "Berlin",
    "zip_code": "10179",
    "address_line1": "Alexanderstr. 36"
  },
  "shipping_address": {
    "country_code": "DE"
  },
  "buyer": {
    "email": "[email protected]",
    "first_name": "Max",
    "last_name": "Mustermann"
  },
  "lines": [
    {
      "line_items": [
        {
          "quantity": 1,
          "external_reference_id": "1",
          "title": "your-product-1",
          "net_price_per_item_cents": 8403,
          "net_price_cents": 8403,
          "tax_cents": 1597
        }
      ],
      "vendor_external_reference_id": "your-vendor-id-1" // vendor ID of first vendor
    },
    {
      "line_items": [
        {
          "quantity": 1,
          "external_reference_id": "2",
          "title": "your-product-2",
          "net_price_per_item_cents": 8403,
          "net_price_cents": 8403,
          "tax_cents": 1597
        }
      ],
      "vendor_external_reference_id": "your-vendor-id-2" // vendor ID of second vendor
    }
  ],
  "external_reference_id": "your-order-ID",
  "gross_amount_cents": 20000,
  "payment_method": "invoice"
}

Invoice Creation

Unlike orders, invoices can only be created per vendor. If you created an order with a multivendor basket, you'll have to create separate invoices for each vendor.