Connect
  1. Schemas
Connect
  • ConnectID API Reference
  • Overview
    • API lifecycle
    • OAuth 2.0
    • About the URLs
    • Google analytics
    • Unite payment SDK
    • Events
      • Authentication
      • Connect realtime events
      • Connect/ConnectID realtime events - flowchart
      • ConnectID events
      • ConnectID realtime events
  • Customer Data
    • Address
      • Change addresses
      • List addresses
      • List addresses - client mode
      • List addresses for product - client mode
      • List addresses for product
    • Category
      • List category types
      • List category codes
      • List category codes for category type
    • Customer
      • List customer info
      • Change customer Info
      • Search customer - client mode
      • Check customer number - client mode
      • List customer info - client mode
    • External Reference
      • Remove external reference - client mode
      • Change external reference - client mode
      • List external references - client mode
      • Register external reference - client mode
  • Order Management
    • Article
      • Check article price
    • Coupon
      • Check coupon price - client mode
      • List coupon - client mode
      • List coupon for coupon number - client mode
    • Fulfillment
      • Complete order - client mode
    • Order
      • Order Guide
        • Introduction
        • How to register an order
        • Complete order by fulfillment URL
        • Complete order by fulfillment API
        • Q&A for order
      • List orders
      • Search order details
      • List order product history
      • List order status - client mode
      • Register customer - client mode
      • Register customer
      • Register order - client mode
      • Register order
    • Reward
      • Check reward - client mode
    • User
      • Assign user - client mode
    • Voucher Coupons
      • List voucher code coupons - client mode
  • Payment Services
    • Invoice
      • List basic invoice info
      • List basic invoice info for product
      • List invoices and reminders
      • List invoices and reminders for product
      • List invoice details
      • List invoices - client mode
      • List invoices for product - client mode
    • InvoiceAddress
      • List invoice address
    • Klarna
      • List klarna recurring tokens
      • Add Klarna token
      • Remove Klarna token
    • Nexi
      • List Nexi subscriptions
      • Add Nexi subscription
      • Remove Nexi subscription
    • PayEx
      • List PayEx tokens
      • Add PayEx token
      • Remove PayEx token
    • Payment
      • List payment methods
      • Pay invoice
      • Change payment method
    • Vipps
      • List vipps agreements
      • Add vipps agreement
      • Remove vipps agreement
  • Privacy
    • Consent
      • Access private data
      • Remove private data
      • List consent event history - client mode
      • List consent text - client mode
      • List consent text history - client mode
      • List consent groups - client mode
      • List consent given issuer - client mode
      • List consent event history
      • List consent given issuer
      • List consent groups
      • Register consent event - client mode
      • Register consent event
    • Permission/Shield
      • List global permissions
      • List enterprise permissions
      • Change enterprise permissions
      • List ordertype permissions
      • Change ordertype permissions
      • Check shield ordertype - client mode
      • Check shield enterprise - client mode
    • Privacy
      • List privacy enterprise
      • Change privacy enterprise
      • List privacy ordertype
      • Change privacy ordertype
  • Product & Services
    • Complaint
      • Register complaint
      • List complaints
    • Delivery
      • List next distributions
      • List next distributions - client mode
    • DeliveryStop
      • Remove delivery stops
      • Register delivery stops
      • List delivery stops
      • List delivery stop - client mode
    • Issue
      • List distributed issues
      • List product issues - client mode
    • Product
      • List products - client mode
      • Check product - client mode
      • List specific products - client mode
    • ProductDeliveryPlan
      • List productdeliveryplan - client mode
    • ProductDependency
      • Check product dependency discount - client mode
    • Sharing
      • Send subscription share invitation
      • Accept subscription share invitation
      • Decline share - client mode
      • List shareable subscription rules
      • List distribution levels
      • Change subscription share invitation details
      • List all shared subscribers
      • Cancel sharing
      • List shareable subscription nets
      • Change shareable subscription nets
      • Change distribution level
    • Subscription
      • List shared subscriptions
      • List subscriptions
      • Start subscription
      • List subscriptions - client mode
  • Recruitment
    • Recruitment
      • Register recruitment - client mode
      • List recruitments
      • List premium recruitments
      • Change premium recruitments
      • Register recruitments
    • RecruitmentCampaign
      • List recruitment campaign - client mode
  • User Data
    • Access
      • Check access
      • Check access - client mode
    • Credential
      • Check credential - client mode
    • Metadata
      • List metadata
      • Change metadata
      • Remove metadata
      • List metadata - client mode
      • Change metadata - client mode
      • Remove metadata - client mode
    • Profile
      • List user profile
      • List external user profiles
  • Diverse
    • External Identity
      • Register external Id - client mode
      • Register customer - client mode
    • Message
      • List messages
      • Send message
      • Send message - client mode
    • Status
      • List status messages
    • Stock
      • Change stocks - client mode
      • List stocks - client mode
      • List stocks for product - client mode
  • Schemas
    • Schemas
      • RemovePrivateData-request
      • AccessPrivateData-request
      • Model-RegisterRecruitment-response
      • Model-ConsentAccess-response
      • Model-Metadata
      • CheckCustomerNumberClientMode-request
      • ChangeStocksClientMode-response
      • ListStatusMessage-response
      • Address
      • CheckRewardClientMode-request
      • CheckRewardClientMode-response
      • Model-Pbm-channels
      • Model-PrivacyOrdertype
      • Model-PrivacyEnterprise
      • RegisterCustomerClientMode-request
      • ChangeStocksClientMode-request
      • Model-CheckShieldClientMode-response
      • Name
      • CheckCustomerNumberClientMode-response
      • Error500
      • Error400
      • Error403
      • ListVoucherCodeCouponsClientMode-response
      • ChangePaymentMethod-response
      • CheckShieldEnterpriseClientMode-request
      • CheckShieldOrdertypeClientMode-request
      • StartSubscription-response
      • Phone Number
      • Order
      • ListCategoryCodes-response
      • CompleteOrderClientMode-response
      • ListInvoiceAddress-response
      • CheckProductClientMode-request
      • CheckArticlePrice-request
      • CheckCouponPriceClientMode-request
      • SearchCustomerClientMode-request
      • SearchCustomerClientMode-response
      • CheckArticlePrice-response
      • CheckCouponPriceClientMode-response
      • RemovePayExToken-response
      • AddPayExToken-response
      • AddPayExToken-request
      • PayInvoice-response
      • AssignUserClientMode-response
      • ListUserProfile-response
      • ListVippsAgreement-response
      • SendMessage-request
      • SendMessageClientMode-Request
      • ChangeCustomerInfo-request
      • RemoveVippsAgreement-response
      • RemoveKlarnaToken-request
      • RemoveVippsAgreement-request
      • AddVippsAgreement-response
      • AddVippsAgreement-request
      • RemoveKlarnaToken-response
      • ListKlarnaTokens-response
      • ListPayExTokens-response
      • RemovePayExToken-request
      • Error404
      • PayInvoice-request
      • CompleteOrderClientMode-request
      • AcceptSubscriptionShareInvitation-request
      • DeclineShareClientMode-request
      • ListCustomerProductShareRule-response
      • ChangeSubscriptionShareInvitationDetails-request
      • CancelSharing-request
      • ChangeDistributionLevel-request
      • Model-SubscriptionShare-response
      • ListStocksClientMode-response
      • CheckProductDependencyDiscount-request
      • CheckProductDependencyDiscount-response
      • ListDistributionLevels-response
      • Success
      • RegisterExternalReferenceClientMode-response
      • ChangeExternalReferenceClientMode-response
      • DeleteExternalReferenceClientMode-response
      • ChangeAddress-request
      • Model-ListAddress
      • ListCouponClientMode-response
      • ListOrderProductHistory-response
      • Name and address for order
      • SearchOrderdetails-request
      • SearchOrderdetails-response
      • Model-ListOrderStatus
      • Name and address for payer
      • Name and address for customer
      • ListBasicInvoiceInfo-response
      • ListInvoiceDetails-response
      • Model-ListNextDistributions
      • Model-ListConsentEventHistory
      • Model-ListConsentGivenIssuer
      • Model-ListConsentGroups
      • RegisterConsentEvent - request
      • RegisterConsentEvent - response
      • ListDistributedIssues-response
      • Model-ListDeliveryStops
      • RegisterDeliveryStops-request
      • RegisterDeliveryStops-response
      • RemoveDeliveryStops-response
      • ListSharedSubscriptions-response
      • Model-Message-response
      • SendSubscriptionShareInvitation-request
      • Model-CheckAccess-request
      • ListCategoryTypes-response
      • StartSubscription-request
      • ListSharedSubscribers-response
      • RegisterComplaint-request
      • Model-Complaint-response
      • CheckCredentialClientMode-request
      • CheckCredentialClientMode-response
      • Model-ListCustomerInfo
      • AssignUserClientMode-request
      • RegisterExternalIdClientMode-request
      • Model-ExternalIdentity-response
      • ListIssuesClientMode-response
      • ListRecruitmentCampaignClientMode-response
      • ListRecruitment-response
      • ChangePremiumRecruitments-request
      • Model-PremiumRecruitments-response
      • ListConsentTextClientMode-response
      • ListUserExternalProfiles-response
      • ListCustomerProductShareNet-response
      • ChangeCustomerProductShareNet-request
      • DeclineShareClientMode-response
      • ListConsentTextHistoryClientMode-response
      • Model-CheckAccess-response
      • ListInvoices-response
      • ListInvoiceClientMode-response
      • ListExternalReferencesClientMode-response
      • ChangeExternalReferenceClientMode-request
      • RegisterExternalReferenceClientMode-request
      • AddKlarnaToken-response
      • AddNexiSubscription-response
      • AddKlarnaToken-request
      • AddNexiSubscription-request
      • RemoveNexiSubscription-response
      • RemoveNexiSubscription-request
      • ListPaymentMethods-response
      • ChangePaymentMethod-request
      • ListNexiSubscriptions-response
      • Model-RegisterOrder-request
      • Model-Product
      • RegisterRecruitmentClientMode-request
      • RegisterRecruitments-request
      • ListproductdeliveryplanClientMode-response
      • Model-ListSubscriptions-response
  1. Schemas

Model-RegisterOrder-request

{
    "externalOrderId": "string",
    "orderDate": 0,
    "paymentMethod": "invoice",
    "merchantId": "string",
    "orderAmount": 0,
    "currency": "str",
    "marketingCouponCode": "string",
    "marketingCouponNumber": 0,
    "campaignParameters": "string",
    "companyCode": "string",
    "customerReference": "string",
    "uniqueUserId": "string",
    "seller": "string",
    "salesMethod": "string",
    "payer": {
        "customerNumber": 0,
        "companyRegistrationNumber": "string",
        "companyName": "string",
        "department": "string",
        "departmentName": "string",
        "personsSocialSecurityNumber": "string",
        "firstName": "string",
        "middleName": "string",
        "lastName": "string",
        "coAddress": "string",
        "careOfAddress": "string",
        "street": "string",
        "streetNumber": 0,
        "entrance": "string",
        "floorType": "s",
        "floor": 0,
        "suite": "string",
        "postalCode": "string",
        "postalPlace": "string",
        "postalAddress": "string",
        "postalAddressPostalCode": "string",
        "postalAddressPostalPlace": "string",
        "countryCode": "str",
        "birthDate": 0,
        "sex": "male",
        "emails": [
            "user@example.com"
        ],
        "phoneNumbers": [
            "string"
        ],
        "invoiceEmailAddress": "string",
        "categories": [
            {
                "addressCategory": "string",
                "freeValue": "string"
            }
        ],
        "permissions": [
            {
                "enterpriseCode": "string",
                "orderTypeCode": "string",
                "channels": [
                    "string"
                ],
                "channelCode": "string",
                "permissionType": "permission"
            }
        ],
        "privacy": [
            {
                "enterpriseCode": "string",
                "orderTypeCode": "string",
                "purpose": "string"
            }
        ]
    },
    "orderLines": [
        {
            "productSpecType": "coupon",
            "productSpecCode": "string",
            "productSpecNo": 0,
            "product": "string",
            "quantity": 0,
            "unitPrice": 0,
            "promotionCode": "string",
            "categoryCode": "string",
            "voucherCode": "string",
            "allowAccessProduct": "string",
            "allowAccessCategoryType": "string",
            "allowAccessSeconds": 0,
            "startInfo": {
                "startDate": 0,
                "startIssue": "string"
            },
            "rewardPartnerId": 0,
            "rewardId": "string",
            "articleDetail": {
                "companyCode": "string",
                "product": "string",
                "articleRef": "string",
                "articleDesc": "string",
                "articleCategory": "string"
            },
            "receiver": {
                "customerNumber": 0,
                "companyRegistrationNumber": "string",
                "companyName": "string",
                "department": "string",
                "departmentName": "string",
                "personsSocialSecurityNumber": "string",
                "firstName": "string",
                "middleName": "string",
                "lastName": "string",
                "coAddress": "string",
                "careOfAddress": "string",
                "street": "string",
                "streetNumber": 0,
                "entrance": "string",
                "floorType": "s",
                "floor": 0,
                "suite": "string",
                "postalCode": "string",
                "postalPlace": "string",
                "postalAddress": "string",
                "postalAddressPostalCode": "string",
                "postalAddressPostalPlace": "string",
                "countryCode": "str",
                "birthDate": 0,
                "sex": "male",
                "emails": [
                    "user@example.com"
                ],
                "phoneNumbers": [
                    "string"
                ],
                "categories": [
                    {
                        "addressCategory": "string",
                        "freeValue": "string"
                    }
                ],
                "permissions": [
                    {
                        "enterpriseCode": "string",
                        "orderTypeCode": "string",
                        "channels": [
                            "string"
                        ],
                        "channelCode": "string",
                        "permissionType": "permission"
                    }
                ],
                "privacy": [
                    {
                        "enterpriseCode": "string",
                        "orderTypeCode": "string",
                        "purpose": "string"
                    }
                ]
            },
            "recruiter": {
                "customerNumber": 0,
                "companyRegistrationNumber": "string",
                "companyName": "string",
                "department": "string",
                "departmentName": "string",
                "personsSocialSecurityNumber": "string",
                "firstName": "string",
                "middleName": "string",
                "lastName": "string",
                "coAddress": "string",
                "careOfAddress": "string",
                "street": "string",
                "streetNumber": 0,
                "entrance": "string",
                "floorType": "s",
                "floor": 0,
                "suite": "string",
                "postalCode": "string",
                "postalPlace": "string",
                "postalAddress": "string",
                "postalAddressPostalCode": "string",
                "postalAddressPostalPlace": "string",
                "countryCode": "str",
                "birthDate": 0,
                "sex": "male",
                "emails": [
                    "user@example.com"
                ],
                "phoneNumbers": [
                    "string"
                ],
                "categories": [
                    {
                        "addressCategory": "string",
                        "freeValue": "string"
                    }
                ],
                "permissions": [
                    {
                        "enterpriseCode": "string",
                        "orderTypeCode": "string",
                        "channels": [
                            "string"
                        ],
                        "channelCode": "string",
                        "permissionType": "permission"
                    }
                ],
                "privacy": [
                    {
                        "enterpriseCode": "string",
                        "orderTypeCode": "string",
                        "purpose": "string"
                    }
                ]
            }
        }
    ],
    "recurring": true,
    "prepaid": false,
    "paymentInfoKCO": {
        "recurringToken": "string",
        "klarnaReference": "string",
        "klarnaOrderId": "string",
        "merchantId": "string",
        "cardNumberMasked": "string",
        "cardExpiryDate": "string",
        "cardBrand": "string",
        "directBankName": "string",
        "directAccountNumber": "string"
    },
    "paymentInfoSmsPay": {
        "phoneNumberMasked": "string",
        "transactionId": "string",
        "merchantId": "string"
    },
    "paymentInfoPayEx": {
        "transactionId": "string",
        "merchantId": "string",
        "recurrenceToken": "string",
        "cardDetails": {
            "cardMaskedPan": "string",
            "expMonth": "st",
            "expYear": "stri",
            "issuingBank": "string",
            "cardBrand": "string",
            "isPanEnrolled": true
        },
        "orderReference": "string"
    },
    "paymentInfoSwishPayEx": {
        "transactionId": "string",
        "merchantId": "string",
        "phoneNumber": "string",
        "transactionSaleId": "string",
        "paymentReference": "string"
    },
    "paymentInfoVippsEcommerce": {
        "transactionId": "string",
        "merchantId": "string"
    },
    "paymentInfoNexi": {
        "paymentId": "string",
        "merchantId": "string",
        "subscriptionId": "string",
        "chargeId": "string",
        "orderReference": "string",
        "paymentDetails": {
            "cardDetails": {
                "cardMaskedPan": "string",
                "expMonth": "st",
                "expYear": "st"
            },
            "paymentType": "CARD",
            "paymentMethod": "AmEx"
        }
    },
    "paymentInfoOther": {
        "transactionId": "string",
        "merchantId": "string",
        "description": "string"
    },
    "mcPayRef": "string",
    "shareCode": "string"
}
Built with