Headless API

List products

Only items that are available online and whose brand the customer is allowed to see. With category_id The items will appear in the category's own sorting order. limit is at most 250, and if it is not specified, the shop's page width is used. ?gtin= looks up a barcode.

{
  "success": true,
  "data": {
    "products": [
      {
        "id": 232167,
        "name": "Terra Nova Etiopien Guji, hele bønner 1 kg",
        "price": 249,
        "old_price": null,
        "buyable": true,
        "url": "https://din-shop.dk/terra-nova-etiopien-guji-hele-boenner-1-kg",
        "rewrite_url": "terra-nova-etiopien-guji-hele-boenner-1-kg",
        "images": [...],
        "categories": [...],
        "brand": { "id": 445, "name": "Terra Nova", "url": "https://dinbutik.dk/brands/terra-nova" }
      }
    ],
    "pagination": {
      "total": 32,
      "limit": 20,
      "offset": 0,
      "pages": 2
    }
  }
}

Prices include sales tax. Names, texts, and addresses are in the local language.

brand.url is the brand's page (Link to or the brand's page), if the store has enabled brand pages; otherwise null.

Single product

{
  "success": true,
  "data": {
    "id": 232167,
    "name": "Terra Nova Etiopien Guji, hele bønner 1 kg",
    "description": "<p>En let og blomstret kaffe ...</p>",
    "sku": "TN-BON-01",
    "price": 249,
    "vat_rate": 25,
    "buyable": true,
    "images": [
      {
        "id": 63924,
        "alt": "Pose med Terra Nova Etiopien Guji kaffebønner",
        "formats": {
          "original": "https://...",
          "large": "https://...",
          "medium": "https://...",
          "small": "https://...",
          "thumbnail": "https://..."
        }
      }
    ],
    "attributes": [...],
    "variants": [...],
    "meta": { "title": "...", "description": "..." }
  }
}

Sold-out variants are not included in variants. Each variant has options with the attribute name and value in the country's language, e.g., {"Farve": "Stål"}. Fields that the customer must fill out themselves (e.g., text for engraving) are listed in attributes with "input_mode": "customer".

Product images have full URLs. Images in categories and blog posts have relative URLs, e.g., /cache/6/5/…/kaffe-fit-800x800x90.png, So, put the store's domain first if you're displaying them from a different domain.

Look up an address

Explains what a "path" in the shop is, so your storefront can use the shop's own addresses. type is home, category, product, page, blog, blog_list, landing, brand_list, brand, redirect or not_found.

{
  "success": true,
  "data": {
    "type": "category",
    "data": { "id": 19112, "name": "Kaffebønner", ... },
    "products": [...],
    "pagination": {...},
    "blocks": {
      "top": "<section ...>...</section>",
      "bottom": "..."
    }
  }
}

brand_list and brand is available when the store has enabled brand pages and the theme has "supports_brand_pages": true. /brands provides brand_list with the brands (id, name, path, logo, product_count), the letters in letters and the number of occurrences per letter in groups. In more than 24 brands, index sand, and featured has up to 12 brands with logos. If there are more than 300, paged sand, and you pick up one letter at a time with ?letter=a. Without ?letter= is brands and groups empty. /brands/<adresse> provides brand with an introduction (description_a), body text (description_b), meta and breadcrumbs as well as the goods in products with ?p= (0 is the first page, 1 is the second), ?sort= and ?sort_order=. /brand/<adresse> and a brand with a link to the provider redirect. Just like in the store, the winner is /brands and a brand that is available through the store's own redirects.

blocks The Page Builder's blocks for the page are rendered as finished HTML using the theme's own templates. Without blocks, the field is null. If you already have page blocks, add them ?blocks=0.

Menus

{
  "menus": [
    {
      "name": "Hovedmenu",
      "location": "top",
      "items": [
        {
          "title": "Kaffe",
          "url": "",
          "type": "menu",
          "children": [
            { "title": "Kaffebønner", "url": "/kaffeboenner", "type": "category", "children": [] }
          ]
        }
      ]
    }
  ]
}

A point of the type menu is a heading for a submenu and has no address.

Select the options available to the customer

Displays the shopping cart, shipping methods, payment methods, and countries all at once, along with the addresses the customer has already entered. Only options the customer can actually select: online payment methods available in the customer’s country, and shipping options that match the cart’s weight and the destination country. When logged in, the customer also sees their B2B options, such as invoice.

Step 1: Address

{
  "step": "address",
  "email": "kunde@example.com",
  "phone": "12345678",
  "name": "Karen Holm",
  "company_name": "",
  "address": "Vestergade 12",
  "zipcode": "8000",
  "city": "Aarhus C",
  "country_id": 188,
  "comments": "",
  "newsletter": 0
}

Business customers can send vat_number and ean_number. A different shipping address is sent as delivery_name, delivery_company, delivery_address, delivery_zipcode, delivery_city and delivery_country_id. The country IDs are listed in GET /api/countries.

The answer is missing_fields (missing fields) and delivers_to_country, so you can display it right away. The order is not rejected until it is completed.

Send the full address every time. This step replaces all fields with what you send, including those you omit. If the customer is logged in, the checkout process uses the account’s address and email, and this step does not save a new address to the account until missing_fields is empty.

Step 2: Delivery

{
  "step": "shipping",
  "shipping_id": 227,
  "delivery_shop_id": "2386"
}

After the address step, shipping methods that include a package pickup location have a list in delivery_shops (number, name, street, zip, city). Send the package shop's number such as delivery_shop_id. Any shipping method not on the list will be rejected. If you do not select a pickup location, the store will choose the first one on the list.

Step 3: Payment Method

{
  "step": "payment",
  "payment_gateway_id": 258
}

Step 4: Complete the order

{
  "step": "complete",
  "payment_flow": "storefront"
}

The payment method is the one from step 3. You can also include it here as payment_id. Before the order is created, the API checks the same things as the store's own checkout process: inventory, minimum order amount, delivery country, address, shipping, and payment method. There are two types of responses.

{
  "success": true,
  "data": {
    "payment_redirect": true,
    "payment_url": "/payment",
    "basket_id": 4809
  }
}

Refer the customer to payment_url. With "payment_flow": "storefront" This is the store's own payment page, which redirects to the payment window and works with all of the store's payment methods. Without it, the API provides the payment window’s address for QuickPay, OnPay, Pensopay, Flatpay, Stripe, Mollie, and Nets Easy. Other methods always go through the store’s payment page. The customer is then redirected back to the store’s /thanks.

{
  "success": true,
  "data": {
    "redirect": "/thanks?basket_id=4809&chk=8ab02e10b1a9ec5db4f1fcee7f49fb05",
    "order_id": 15505,
    "webshop_order_id": 4522,
    "chk": "8ab02e10b1a9ec5db4f1fcee7f49fb05",
    "payment_info": "<p>Overfør beløbet til ...</p>"
  }
}

payment_info is the store's own description of the payment method, such as the account number for a bank transfer. webshop_order_id is the order number that the customer sees.

Log In and Out

{
  "email": "kunde@example.com",
  "password": "..."
}

Use the same login as in the online store. Once logged in, the customer will see their customer group prices, payment methods, and address pre-filled. An incorrect email address or password will result in 401 login_failed.

The logged-in customer

{
  "customer": {
    "id": 2224,
    "email": "kunde@example.com",
    "name": "Karen Holm",
    "address": "Vestergade 12",
    "zipcode": "8000",
    "city": "Aarhus C",
    "country_id": 188,
    "shipping_address": null,
    "points": 120,
    "urls": { "profile": "/user-profile", "orders": "/user-orders", "edit": "/user-edit" }
  }
}

Without logging in, customer null. points is the customer's point balance and null, when the store doesn't have a loyalty program.

Customer Orders

The list includes the order number, date, status, total, currency, and the address of the order page. A single order has the same fields as GET /api/order. Without logging in: 401 login_required.