PUT api/OmsOrderCustomerInformation/update
Request Information
URI Parameters
None.
Body Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| BillingGivenName | string |
Required |
|
| BillingSurName | string |
Required |
|
| BillingPhoneticGivenName | string |
None. |
|
| BillingPhoneticSurName | string |
None. |
|
| BillingCompanyName | string |
None. |
|
| BillingEmail | string |
Required |
|
| BillingChangeEmailGlobally | string |
None. |
|
| BillingPhone | string |
Required |
|
| BillingAddress1 | string |
Required |
|
| BillingAddress2 | string |
None. |
|
| BillingAddress3 | string |
None. |
|
| BillingLocality | string |
Required |
|
| BillingProvince | string |
Required |
|
| BillingPostalCode | string |
Required |
|
| BillingCountry | string |
Required |
|
| ShippingGivenName | string |
Required |
|
| ShippingSurName | string |
Required |
|
| ShippingPhoneticGivenName | string |
None. |
|
| ShippingPhoneticSurName | string |
None. |
|
| ShippingCompanyName | string |
None. |
|
| ShippingPhone | string |
Required |
|
| ShippingAddress1 | string |
Required |
|
| ShippingAddress2 | string |
None. |
|
| ShippingAddress3 | string |
None. |
|
| ShippingLocality | string |
Required |
|
| ShippingProvince | string |
Required |
|
| ShippingPostalCode | string |
Required |
|
| ShippingCountry | string |
Required |
|
| InternalNote | string |
Required |
|
| SendEmailToCustomer | boolean |
None. |
|
| MaxAddressLength | integer |
None. |
|
| OrderID | integer |
None. |
|
| OrderHistoryDetail | OrderHistoryDetail |
None. |
Request Formats
application/json, text/json
Sample:
{
"BillingGivenName": "sample string 1",
"BillingSurName": "sample string 2",
"BillingPhoneticGivenName": "sample string 3",
"BillingPhoneticSurName": "sample string 4",
"BillingCompanyName": "sample string 5",
"BillingEmail": "sample string 6",
"BillingChangeEmailGlobally": "sample string 7",
"BillingPhone": "sample string 8",
"BillingAddress1": "sample string 9",
"BillingAddress2": "sample string 10",
"BillingAddress3": "sample string 11",
"BillingLocality": "sample string 12",
"BillingProvince": "sample string 13",
"BillingPostalCode": "sample string 14",
"BillingCountry": "sample string 15",
"ShippingGivenName": "sample string 16",
"ShippingSurName": "sample string 17",
"ShippingPhoneticGivenName": "sample string 18",
"ShippingPhoneticSurName": "sample string 19",
"ShippingCompanyName": "sample string 20",
"ShippingPhone": "sample string 21",
"ShippingAddress1": "sample string 22",
"ShippingAddress2": "sample string 23",
"ShippingAddress3": "sample string 24",
"ShippingLocality": "sample string 25",
"ShippingProvince": "sample string 26",
"ShippingPostalCode": "sample string 27",
"ShippingCountry": "sample string 28",
"InternalNote": "sample string 29",
"SendEmailToCustomer": true,
"MaxAddressLength": 31,
"OrderID": 32,
"OrderHistoryDetail": {
"ChangeType": 0,
"ObjectID": 1,
"OHHead": "sample string 2",
"OHBody": "sample string 3",
"OHFoot": "sample string 4",
"ShowToInterface": true,
"GroupTogetherID": "sample string 6",
"HistoryTimeUTC": "2025-12-20T23:42:51.7244706+00:00"
}
}
application/xml, text/xml
Sample:
<CustomerEditForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.OMS.Domain.Models"> <BillingAddress1>sample string 9</BillingAddress1> <BillingAddress2>sample string 10</BillingAddress2> <BillingAddress3>sample string 11</BillingAddress3> <BillingChangeEmailGlobally>sample string 7</BillingChangeEmailGlobally> <BillingCompanyName>sample string 5</BillingCompanyName> <BillingCountry>sample string 15</BillingCountry> <BillingEmail>sample string 6</BillingEmail> <BillingGivenName>sample string 1</BillingGivenName> <BillingLocality>sample string 12</BillingLocality> <BillingPhone>sample string 8</BillingPhone> <BillingPhoneticGivenName>sample string 3</BillingPhoneticGivenName> <BillingPhoneticSurName>sample string 4</BillingPhoneticSurName> <BillingPostalCode>sample string 14</BillingPostalCode> <BillingProvince>sample string 13</BillingProvince> <BillingSurName>sample string 2</BillingSurName> <InternalNote>sample string 29</InternalNote> <MaxAddressLength>31</MaxAddressLength> <OrderID>32</OrderID> <SendEmailToCustomer>true</SendEmailToCustomer> <ShippingAddress1>sample string 22</ShippingAddress1> <ShippingAddress2>sample string 23</ShippingAddress2> <ShippingAddress3>sample string 24</ShippingAddress3> <ShippingCompanyName>sample string 20</ShippingCompanyName> <ShippingCountry>sample string 28</ShippingCountry> <ShippingGivenName>sample string 16</ShippingGivenName> <ShippingLocality>sample string 25</ShippingLocality> <ShippingPhone>sample string 21</ShippingPhone> <ShippingPhoneticGivenName>sample string 18</ShippingPhoneticGivenName> <ShippingPhoneticSurName>sample string 19</ShippingPhoneticSurName> <ShippingPostalCode>sample string 27</ShippingPostalCode> <ShippingProvince>sample string 26</ShippingProvince> <ShippingSurName>sample string 17</ShippingSurName> </CustomerEditForm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
| Name | Description | Type | Additional Information |
|---|---|---|---|
| ResponseCode | APIResponseCodes |
None. |
|
| Message | string |
None. |
|
| CorrelationId | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"ResponseCode": 0,
"Message": "sample string 1",
"CorrelationId": "sample string 2"
}
application/xml, text/xml
Sample:
<GenericResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DECK.Core.Common.Contracts.API"> <CorrelationId>sample string 2</CorrelationId> <Message>sample string 1</Message> <ResponseCode>Success</ResponseCode> </GenericResponse>