API Customer Documentation, Training & Roll Out

Owned by Sehrish Shafqat
Last updated: Dec 28, 2022
2 min read

This documentation will include examples of Customer API JSON, Customer can be created via API with template and without template.


With template only

{

"customerNumber": null,

"postTemplate": "Customer N",

"name": "Template"


}

With template + Few Customer data (which you want to add other than template)

{
"customerNumber": null,
"postTemplate": "Customer N",
"name": "Template",

"customerForwarderNumbers":

[
{
"forwarder": "HJH",
"clientWarehouse": "HJH",
"transportMode": "HJH_13",
"transportModeName": "Afhentes",
"forwarderCustomerNumber": "333"
},
{
"forwarder": "Click&Collect",
"clientWarehouse": "98CNS-FT3",
"transportMode": "CCKO",
"transportModeName": "Click&Collect",
"forwarderCustomerNumber": "333"
}
]

}

With no template (Add only Required data, Simplest JSON)

{

"customerNumber": null,
"postTemplate": null,
"name": "Customer name",

"vatRegistered": true,
"adviceToPhone": "9999",
"customerFinancialSettings": {
"approvalNeededForOrder": false
},
"customerClassification": {
"internalCustomer": false
},
"customerLogisticsSettings": {
"customerFreightAgreement": "Standard"
},
"customerDeliveryAddress": {
"address": {
"address1": "CustomerAPI test",
"postalCode": "1234",
"city": "CustomerAPI test",
"country": "DK"

}
}
}

With no template (Required values + few other settings)

{
"customerNumber": "",
"postTemplate": null,
"name": "name",
"vatRegistered": true,
"adviceToPhone": "123456",
"customerFinancialSettings": {
"calculateDueDateFromNextMonth": true,
"invoiceAfterAskedDeliveryDatePassed": false,
"approvalNeededForOrder": false
},
"customerClassification": {
"customerType": "Private",
"internalCustomer": true

},
"customerLogisticsSettings": {
"customerFreightAgreement": "TivoliOLD",
"defaultPartialDelivery": "Yes",
"deliveryDayLeadTimeOverride": false,
"planningRequired": false
},
"customerInvoiceAddress": {
"name": "Invoice name",
"address":{
"address1": "Invoice name",
"PostalCode": "1234",
"City": "Invoice address",
"Country": "DK"
}
},
"customerDeliveryAddress": {
"address": {
"address1": "CustomerAPI test",
"PostalCode": "1234",
"City": "CustomerAPI test",
"Country": "DK"

},

"doorCode": "doorcode"
},
"customerVisitingAddress": {
"address" : {
"address1": "Visiting address",
"PostalCode": "1234",
"City": "Visiting city",
"Country": "DK"
}
}
}

With no template (Complete structure)

{
"customerNumber": "",
"postTemplate": null,
"name": "Complete",
"lastName": "",
"alfaSearch": "",
"invoiceEmail": "Emailinvoice@gmail.com",
"orderConfirmationEmail": "Emaildelivery@gmail.com",
"deliveryNoteEmail": "Emailadvice@gmail.com",
"orderConfirmationBCCEmail": "",
"organizationNumber": "CDN-1234",
"vatNumber": "VAT-123456",
"vatRegistered": false,
"agreementNumber": "AGR-123456",
"adviceToPhone": "123456",
"phone": "",
"fax": "Fax-12345",
"homepage": "",
"masterDataManualStatusNotes": "",
"customerStatus": "Active",
"masterDataSettingStatus": "Incomplete",
"customerFinancialSettings": {
"creditLimit": 0,
"calculateDueDateFromNextMonth": false,
"customerInvoiceSendFormat": "Pdf",
"customerInvoiceSendReviewType": "NoReview",
"customerInvoiceSendSystem": "Extend",
"customerInvoicingProcess": "Detailed",
"preferedCustomerInvoiceSendType": "None",
"invoiceAfterAskedDeliveryDatePassed": false,
"defaultPaymentType": 0,
"payingCustomerNumber": "",
"penaltyInterestPercent": 0,
"approvalNeededForOrder": false,
"termsOfPayment": "",
"exciseNumber": "Exc-123456"
},
"customerClassification": {
"customerType": "Unknown",
"customerFinancialCategory": null,
"companyGroup": "Advodan",
"internalCustomer": false,
"statisticalCategory1": "API 1",
"statisticalCategory2": "API 1",
"statisticalCategory3": "API 1",
"salesman": "Allan Jørgensen",
"bonusProgramMember": null,
"aBC": null
},
"customerLogisticsSettings": {
"customerFreightAgreement": "Standard",
"customerOrderingType": "Bookable",
"defaultPartialDelivery": "Unknown",
"deliveryDayLeadTimeOverride": false,
"departure": null,
"description": "",
"route": null,
"shippingMark": null,
"planningRequired": false,
"backOrderSetting": "Clientsdefault",
"consolidateDelivery": null,
"palletRegistrationNumber": "",
"termsOfDelivery": "",
"transportCondition": "DDP",
"webshopWarehouseOverride": null
},
"customerInvoiceAddress": {
"name": "Complete",
"address": {
"address1": "Delivery address",
"address2": "",
"address3": "",
"postalCode": "1234",
"city": "Code",
"state": "state",
"country": "DK",
"addressEAN": "EAN-123456"
}
},
"customerDeliveryAddress": {
"address": {
"address1": "Delivery address",
"address2": "",
"address3": "",
"postalCode": "1234",
"city": "Code",
"state": "state",
"country": "DK",
"addressEAN": "EAN-123456"
},
"addressExciseNumber": "EX-123456",
"latitude": null,
"longitude": null,
"doorCode": null
},
"customerVisitingAddress": {
"address": {
"address1": "Delivery address",
"address2": "",
"address3": "",
"postalCode": "1234",
"city": "Code",
"state": "state",
"country": "DK",
"addressEAN": "EAN-123456"
}
},
"customerAdditionalDeliveryAddresses": [
{
"name": "Alternate address name",
"address": {
"address1": "Address",
"address2": "",
"address3": "",
"postalCode": "1234",
"city": "code",
"state": "state",
"country": "DK",
"addressEAN": "EAN-12345"
}
}
],
"customerGroups": [
{
"name": "300115",
"description": null
}
],
"customerClasses": [
{
"name": "member",
"description": null
}
],
"customerForwarderNumbers": [
{
"forwarder": "HJH",
"clientWarehouse": "98CNS-FT3",
"transportMode": "HJH_13",
"transportModeName": "Afhentes",
"forwarderCustomerNumber": "444"
}
],
"customerContacts": [
{
"title": "Title",
"firstName": "Firstname GG",
"middleName": "",
"lastName": "Surname CC",
"phone": "",
"mobile": "",
"mobile2": "",
"mobile3": "",
"fax": "",
"eMail": "",
"address1": "Address",
"address2": "",
"address3": "",
"postalCode": "12345",
"city": "code",
"state": "",
"country": "SE",
"description": ""
}
],
"customerUsers": [
{
"title": "Title",
"firstName": "Firstname user 22",
"middleName": "",
"lastName": "Surname 33",
"phone": "",
"mobile": "",
"mobile2": "",
"mobile3": "",
"fax": "",
"eMail": "",
"userName": "Username YYY",
"address1": "Address",
"address2": "",
"address3": "",
"postalCode": "12345",
"city": "Code",
"state": "",
"country": "SE",
"description": ""
}
]
}