API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- POSTAdd Account And Login
- POSTAdd Accounts
- POSTAdd Login To Existing Customer
- POSTChange Password
- POSTChange Passwords
- GETGet Account
- PUTUpdate Account
- DELDelete Account
- GETGet Account Attribute
- PUTUpdate Account Attribute
- DELDelete Account Attribute
- GETGet Account Attributes
- POSTAdd Account Attribute
- GETGet Account Audit Log
- GETGet Account Card
- PUTUpdate Account Card
- DELDelete Account Card
- GETGet Account Cards
- POSTAdd Account Card
- GETGet Account Contact
- PUTUpdate Account Contact
- DELDelete Account Contact
- GETGet Account Contacts
- PUTAdd Account Contact List
- POSTAdd Account Contact
- GETGet Account Note
- PUTUpdate Account Note
- DELDelete Account Note
- GETGet Account Notes
- POSTAdd Account Note
- GETGet Account Segments
- GETGet Accounts
- POSTAdd Account
- GETGet Customer Purchase Order Account
- PUTUpdate Customer Purchase Order Account
- POSTCreate Customer Purchase Order Account
- GETGet Customer Purchase Order Transactions
- POSTCreate Purchase Order Transaction
- POSTGet Customers Purchase Order Accounts
- GETGet Login State
- POSTGet Login State By Email Address
- POSTGet Login State By UserName
- GETGet Transactions
- POSTAdd Transaction
- POSTRecompute Customer Lifetime Value
- DELRemove Transaction
- POSTReset Password
- GETRetrieve Current Account
- POSTSet Login Locked
- POSTSet Password Change Required
- POSTUpdate Forgotten Password
A valid request URL is required to generate request examples{
"accountId": 123,
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"faxNumber": "<string>",
"firstName": "<string>",
"id": 123,
"label": "<string>",
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"types": [
{
"isPrimary": true,
"name": "<string>"
}
]
}Add Account Contact
Creates a new CustomerContact for a customer account, for example, a new shipping address.
A valid request URL is required to generate request examples{
"accountId": 123,
"address": {
"address1": "<string>",
"address2": "<string>",
"address3": "<string>",
"address4": "<string>",
"addressType": "<string>",
"cityOrTown": "<string>",
"countryCode": "<string>",
"isValidated": true,
"postalOrZipCode": "<string>",
"stateOrProvince": "<string>"
},
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"companyOrOrganization": "<string>",
"email": "<string>",
"faxNumber": "<string>",
"firstName": "<string>",
"id": 123,
"label": "<string>",
"lastNameOrSurname": "<string>",
"middleNameOrInitial": "<string>",
"phoneNumbers": {
"home": "<string>",
"mobile": "<string>",
"work": "<string>"
},
"types": [
{
"isPrimary": true,
"name": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the customer account to contain the new CustomerContact.
Query Parameters
limits which fields are returned in the response body
Body
Properties of the new CustomerContact. Required properties: CustomerContact.Email, ContactType.
CustomerContact information for a customer account including the name, company, phone numbers, email addresses, and billing and shipping addresses (if supplied).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
CustomerContact information for a customer account including the name, company, phone numbers, email addresses, and billing and shipping addresses (if supplied).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes