Event Overview - Payload - Entity - Order

Target Audience: Users, Developers, Stakeholders

Introduction

This document defines the entity order for an event payload.

Description

The prder entity in the payload object.

{
  "order": {
    "id": "622f061795cfebfded83077a",
    "organisation_id": "organisation",
    "account_id": "622f061795cfebfded830774",
    "order_id": "ORGANISATION-1",
    "payment_option": "klarna_payments",
    "purchase_type": "recurring",
    "masked_credit_card": "",
    "state": "closed",
    "total_price": "32.00",
    "total_vat_cost": "1.81",
    "total_discount": "0.00",
    "traffic_source": "paywall",
    "parent_order": "",
    "delivery_address": {
      "id": "622f061995cfebfded830787",
      "first_name": "John",
      "last_name": "Doe",
      "street": "Gata",
      "street_number": "3",
      "staircase": "",
      "floor": "",
      "apartment_number": "",
      "zip_code": "11460",
      "city": "Stockholm",
      "mobile_number": null,
      "phone_number": "",
      "email": "",
      "country_code": "SE"
    },
    "details": [{
      "id": "622f061795cfebfded83077c",
      "product_id": "607d31ff95cfeb500a33c993",
      "product_name": "Digital tidning",
      "product_code": "digital_tidning",
      "product_title_code": "TITLE_CODE",
      "product_title_name": "Title name",
      "integration_code": "",
      "description": "Digital tidning (prenumeration, 1 månad)",
      "vat_code": 6,
      "price": "32.0",
      "period": {
        "type": "month",
        "length": 1
      },
      "campaign_package_or_package_product_code": "digital_tidning",
      "is_campaign": true
    }],
    "payments": [{
      "id": "622f061795cfebfded83077e",
      "product_id": "607d31ff95cfeb500a33c993",
      "product_title_code": "TITLE_CODE",
      "product_title_name": "Title name",
      "user_product_id": "",
      "type": "normal",
      "state": "closed",
      "amount": "32.00",
      "vat_amount": "1.81",
      "transaction_number": "2LG88Q3X",
      "error_code": "",
      "created": "2022-03-14T10:08:39+01:00",
      "updated": "2022-03-14T10:08:41+01:00"
    }],
    "created": "2022-03-14T10:08:39+01:00",
    "updated": "2022-03-14T10:08:41+01:00",
    "subscription_start": null,
    "merchant_reference": "dd9dbca6-8bd7-4986-a66d-xxxxxxxx",
    "limited_campaign": false,
    "flex_campaign_details": {
      "price_string": "129 kr/månad, därefter ordinarie pris",
      "total_length": "2022-06-14T10:08:41+01:00"
    }
  }
}