Updates Customer
Sample request:
PUT /customers
{
"first_name": "FirstNameUser",
"last_name": "LastNameUser",
"company": "company",
"abn": "abn",
"phone": "+321",
"fax": "fax",
"mobile": "+123",
"email": "email@lel.org",
"website": "website.org",
"custom_reference": "customReference",
"customer_type": {
"name": "type1",
"id": 5
},
"home_outlet": {
"id": 1,
"name": "name"
},
"date_of_birth": "1999-04-30",
"date_of_birth_withheld": false,
"marketing":{
"receive_email": true,
"receive_post": true,
"receive_sms": true
},
"price_groups": [
{
"id": 1,
"name": "name1",
"type": "Standard"
},
{
"id": 5,
"name": "name2",
"type": "Fixed"
}],
"billing_address": {
"address_line1": "address_line1",
"address_line2": "address_line2",
"suburb": "suburb",
"state": "state",
"postcode": "postcode",
"country": "country"
},
"loyalty_program": {
"enabled": false,
"auto_price_group": false
},
"account_customer": {
"enabled": false,
"payment_terms": 0,
"credit_limit": 0,
"credit_blocked": false,
"credit_remaining": 10
},
"survey_responses": [{
"id": 1,
"question": "question1",
"answer": "answer"
}],
"sales_channels": [{
"id": 1
},
{
"id": 2
}]
}
Path Parameters
Customer id
Example:10000
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Body
application/json
Body
Customer model
EmptyExample
Response
application/json
Response
Returns updated Customer
Customer
Customer model
Account customer view model
Show Child Parameters
Acn
Billing address model
Show Child Parameters
Company
Customer number
Customer type model
Show Child Parameters
Date of birth
Date of birth with held
Delivery Address model
Show Child Parameters
Fax
First name
Identifier
Last name
Loyalty program model
Show Child Parameters
Marketing view model
Show Child Parameters
Mobile
Phone
Price group model
Show Child Parameters
Survey Response model
Show Child Parameters
Website
Show Child Parameters
Custom reference
Export to web
Total Payments
Total Transactions
CustomerSalesChannel Model
Show Child Parameters
Created on
Modified on
Path Parameters
Headers
Body
Searches Delivery Addresses by Customer id and other parameters
Searches Delivery Addresses by Customer id and other parameters
Query Parameters
Is default
Modified since
>= 1<= 100000
>= 1<= 2147483647
Path Parameters
Customer id
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
Returns Delivery Address data
DeliveryAddress.PagingResponse
Delivery Address model
Show Child Parameters
Path Parameters
Query Parameters
Headers
Creates Customer Delivery Address
Sample request:
POST /customers/{id}/deliveryaddresses
{
"country": "Argentina",
"state": "QLD",
"suburb": "Maroochydore",
"address_line1": "address line 1",
"address_line2": "address line 2",
"postcode": "4000",
"company": "Retail Express",
"mobile": "0405 966 390",
"phone": "0405966390",
"first_name": "Bernie",
"last_name": "Green",
"default": false
}
Path Parameters
Customer id
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Body
application/json
Body
Delivery Address model
EmptyExample
Response
application/json
Response
Delivery Address was created
DeliveryAddress
Delivery Address model
Country
Country Code
State
Suburb
Address line 1
Address line 2
Post code
Company
Mobile phone
Phone
First name
Last Name
Identifier
Is Default
Modified on
Path Parameters
Headers
Body
Gets specific Delivery Address by unique Customer id and Delivery Address id
Gets specific Delivery Address by unique Customer id and Delivery Address id
Path Parameters
Customer id
Delivery Address id
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
application/json
Response
Returns a Delivery Address
DeliveryAddress
Delivery Address model
Country
Country Code
State
Suburb
Address line 1
Address line 2
Post code
Company
Mobile phone
Phone
First name
Last Name
Identifier
Is Default
Modified on
Path Parameters
Headers
Deletes specific Delivery Address by unique Customer id and Delivery Address id
Deletes specific Delivery Address by unique Customer id and Delivery Address id
Path Parameters
Customer id
Example:10000
Delivery Address id
Example:1
Headers
Api subscription key
Default:no-cache
Bearer token for authorization (e.g., Bearer )
Response
Response
Customer Delivery Address deleted