POST api/Customer/Create
Request Information
URI Parameters
None.
Body Parameters
CreateCustomerParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| OfficeID | integer |
None. |
|
| AccountNumber | string |
None. |
|
| ARAccountNumber | string |
None. |
|
| CustomerName | string |
None. |
|
| CountryID | string |
None. |
|
| InvoiceName | string |
None. |
|
| InvoiceAddress1 | string |
None. |
|
| InvoiceAddress2 | string |
None. |
|
| InvoiceAddress3 | string |
None. |
|
| InvoiceCityName | string |
None. |
|
| InvoiceStateProvID | string |
None. |
|
| InvoicePostalCode | string |
None. |
|
| InvoiceCountryID | string |
None. |
|
| InvoiceAttention | string |
None. |
|
| AccountStatus | string |
None. |
|
| HoldNote | string |
None. |
|
| Balance | decimal number |
None. |
|
| RevenueToDate | decimal number |
None. |
|
| RevenueYearToDate | decimal number |
None. |
|
| CurrencyID | string |
None. |
|
| SalesPersonID | integer |
None. |
|
| BillingCycleID | integer |
None. |
|
| CreditLimit | decimal number |
None. |
|
| PaymentTerms | integer |
None. |
|
| OpenDateTime | date |
None. |
|
| CloseDateTime | date |
None. |
|
| LastOrderDateTime | date |
None. |
|
| LastInvoiceDateTime | date |
None. |
|
| InvoiceBreak | string |
None. |
|
| InvoiceBreakAmount | decimal number |
None. |
|
| ReferenceValue | string |
None. |
|
| ReferenceRequired | boolean |
None. |
|
| ReferenceLocked | boolean |
None. |
|
| CustomerClassID | integer |
None. |
|
| InsertUserID | integer |
None. |
|
| BillToCustomerID | integer |
None. |
|
| NextSalesReview | date |
None. |
|
| NextCreditReview | date |
None. |
|
| TaxTypeID | string |
None. |
|
| TaxCountryID | string |
None. |
|
| TaxNumber | string |
None. |
|
| TimezoneID | string |
None. |
|
| PickupAddressID | integer |
None. |
|
| PickupAddressCode | string |
None. |
|
| PickupCompanyName | string |
None. |
|
| PickupAddress1 | string |
None. |
|
| PickupAddress2 | string |
None. |
|
| PickupAddress3 | string |
None. |
|
| PickupCityName | string |
None. |
|
| PickupStateProvID | string |
None. |
|
| PickupPostalCode | string |
None. |
|
| PickupCountryID | string |
None. |
|
| PickupTimezoneID | string |
None. |
|
| PickupContactName | string |
None. |
|
| PickupPhoneNumber | string |
None. |
|
| PickupAfterHoursNumber | string |
None. |
|
| PickupFaxNumber | string |
None. |
|
| PickupEmailAddress | string |
None. |
|
| PickupInstructions | string |
None. |
|
| PickupDefaultAirportID | string |
None. |
|
| PickupDistanceToAirport | integer |
None. |
|
| PickupDistanceUOM | string |
None. |
|
| DeliveryAddressID | integer |
None. |
|
| DeliveryAddressCode | string |
None. |
|
| DeliveryCompanyName | string |
None. |
|
| DeliveryAddress1 | string |
None. |
|
| DeliveryAddress2 | string |
None. |
|
| DeliveryAddress3 | string |
None. |
|
| DeliveryCityName | string |
None. |
|
| DeliveryStateProvID | string |
None. |
|
| DeliveryPostalCode | string |
None. |
|
| DeliveryCountryID | string |
None. |
|
| DeliveryTimezoneID | string |
None. |
|
| DeliveryContactName | string |
None. |
|
| DeliveryPhoneNumber | string |
None. |
|
| DeliveryAfterHoursNumber | string |
None. |
|
| DeliveryFaxNumber | string |
None. |
|
| DeliveryEmailAddress | string |
None. |
|
| DeliveryInstructions | string |
None. |
|
| DeliveryDefaultAirportID | string |
None. |
|
| DeliveryDistanceToAirport | integer |
None. |
|
| DeliveryDistanceUOM | string |
None. |
|
| SecurityCode | string |
None. |
|
| IsPuDefault | boolean |
None. |
|
| IsDelDefault | boolean |
None. |
|
| BillingUserGUID | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"OfficeID": 2,
"AccountNumber": "sample string 3",
"ARAccountNumber": "sample string 4",
"CustomerName": "sample string 5",
"CountryID": "sample string 6",
"InvoiceName": "sample string 7",
"InvoiceAddress1": "sample string 8",
"InvoiceAddress2": "sample string 9",
"InvoiceAddress3": "sample string 10",
"InvoiceCityName": "sample string 11",
"InvoiceStateProvID": "sample string 12",
"InvoicePostalCode": "sample string 13",
"InvoiceCountryID": "sample string 14",
"InvoiceAttention": "sample string 15",
"AccountStatus": "sample string 16",
"HoldNote": "sample string 17",
"Balance": 18.0,
"RevenueToDate": 19.0,
"RevenueYearToDate": 20.0,
"CurrencyID": "sample string 21",
"SalesPersonID": 22,
"BillingCycleID": 23,
"CreditLimit": 24.0,
"PaymentTerms": 25,
"OpenDateTime": "2025-12-03T12:36:01.3010852+00:00",
"CloseDateTime": "2025-12-03T12:36:01.3010852+00:00",
"LastOrderDateTime": "2025-12-03T12:36:01.3010852+00:00",
"LastInvoiceDateTime": "2025-12-03T12:36:01.3010852+00:00",
"InvoiceBreak": "sample string 27",
"InvoiceBreakAmount": 1.0,
"ReferenceValue": "sample string 28",
"ReferenceRequired": true,
"ReferenceLocked": true,
"CustomerClassID": 31,
"InsertUserID": 32,
"BillToCustomerID": 1,
"NextSalesReview": "2025-12-03T12:36:01.3010852+00:00",
"NextCreditReview": "2025-12-03T12:36:01.3010852+00:00",
"TaxTypeID": "sample string 33",
"TaxCountryID": "sample string 34",
"TaxNumber": "sample string 35",
"TimezoneID": "sample string 36",
"PickupAddressID": 1,
"PickupAddressCode": "sample string 37",
"PickupCompanyName": "sample string 38",
"PickupAddress1": "sample string 39",
"PickupAddress2": "sample string 40",
"PickupAddress3": "sample string 41",
"PickupCityName": "sample string 42",
"PickupStateProvID": "sample string 43",
"PickupPostalCode": "sample string 44",
"PickupCountryID": "sample string 45",
"PickupTimezoneID": "sample string 46",
"PickupContactName": "sample string 47",
"PickupPhoneNumber": "sample string 48",
"PickupAfterHoursNumber": "sample string 49",
"PickupFaxNumber": "sample string 50",
"PickupEmailAddress": "sample string 51",
"PickupInstructions": "sample string 52",
"PickupDefaultAirportID": "sample string 53",
"PickupDistanceToAirport": 1,
"PickupDistanceUOM": "sample string 54",
"DeliveryAddressID": 1,
"DeliveryAddressCode": "sample string 55",
"DeliveryCompanyName": "sample string 56",
"DeliveryAddress1": "sample string 57",
"DeliveryAddress2": "sample string 58",
"DeliveryAddress3": "sample string 59",
"DeliveryCityName": "sample string 60",
"DeliveryStateProvID": "sample string 61",
"DeliveryPostalCode": "sample string 62",
"DeliveryCountryID": "sample string 63",
"DeliveryTimezoneID": "sample string 64",
"DeliveryContactName": "sample string 65",
"DeliveryPhoneNumber": "sample string 66",
"DeliveryAfterHoursNumber": "sample string 67",
"DeliveryFaxNumber": "sample string 68",
"DeliveryEmailAddress": "sample string 69",
"DeliveryInstructions": "sample string 70",
"DeliveryDefaultAirportID": "sample string 71",
"DeliveryDistanceToAirport": 1,
"DeliveryDistanceUOM": "sample string 72",
"SecurityCode": "sample string 73",
"IsPuDefault": true,
"IsDelDefault": true,
"BillingUserGUID": "sample string 76"
}
application/xml, text/xml
Sample:
<CreateCustomerParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ARAccountNumber>sample string 4</ARAccountNumber> <AccountNumber>sample string 3</AccountNumber> <AccountStatus>sample string 16</AccountStatus> <Balance>18</Balance> <BillToCustomerID>1</BillToCustomerID> <BillingCycleID>23</BillingCycleID> <BillingUserGUID>sample string 76</BillingUserGUID> <CloseDateTime>2025-12-03T12:36:01.3010852+00:00</CloseDateTime> <CountryID>sample string 6</CountryID> <CreditLimit>24</CreditLimit> <CurrencyID>sample string 21</CurrencyID> <CustomerClassID>31</CustomerClassID> <CustomerName>sample string 5</CustomerName> <DeliveryAddress1>sample string 57</DeliveryAddress1> <DeliveryAddress2>sample string 58</DeliveryAddress2> <DeliveryAddress3>sample string 59</DeliveryAddress3> <DeliveryAddressCode>sample string 55</DeliveryAddressCode> <DeliveryAddressID>1</DeliveryAddressID> <DeliveryAfterHoursNumber>sample string 67</DeliveryAfterHoursNumber> <DeliveryCityName>sample string 60</DeliveryCityName> <DeliveryCompanyName>sample string 56</DeliveryCompanyName> <DeliveryContactName>sample string 65</DeliveryContactName> <DeliveryCountryID>sample string 63</DeliveryCountryID> <DeliveryDefaultAirportID>sample string 71</DeliveryDefaultAirportID> <DeliveryDistanceToAirport>1</DeliveryDistanceToAirport> <DeliveryDistanceUOM>sample string 72</DeliveryDistanceUOM> <DeliveryEmailAddress>sample string 69</DeliveryEmailAddress> <DeliveryFaxNumber>sample string 68</DeliveryFaxNumber> <DeliveryInstructions>sample string 70</DeliveryInstructions> <DeliveryPhoneNumber>sample string 66</DeliveryPhoneNumber> <DeliveryPostalCode>sample string 62</DeliveryPostalCode> <DeliveryStateProvID>sample string 61</DeliveryStateProvID> <DeliveryTimezoneID>sample string 64</DeliveryTimezoneID> <HoldNote>sample string 17</HoldNote> <InsertUserID>32</InsertUserID> <InvoiceAddress1>sample string 8</InvoiceAddress1> <InvoiceAddress2>sample string 9</InvoiceAddress2> <InvoiceAddress3>sample string 10</InvoiceAddress3> <InvoiceAttention>sample string 15</InvoiceAttention> <InvoiceBreak>sample string 27</InvoiceBreak> <InvoiceBreakAmount>1</InvoiceBreakAmount> <InvoiceCityName>sample string 11</InvoiceCityName> <InvoiceCountryID>sample string 14</InvoiceCountryID> <InvoiceName>sample string 7</InvoiceName> <InvoicePostalCode>sample string 13</InvoicePostalCode> <InvoiceStateProvID>sample string 12</InvoiceStateProvID> <IsDelDefault>true</IsDelDefault> <IsPuDefault>true</IsPuDefault> <LastInvoiceDateTime>2025-12-03T12:36:01.3010852+00:00</LastInvoiceDateTime> <LastOrderDateTime>2025-12-03T12:36:01.3010852+00:00</LastOrderDateTime> <NextCreditReview>2025-12-03T12:36:01.3010852+00:00</NextCreditReview> <NextSalesReview>2025-12-03T12:36:01.3010852+00:00</NextSalesReview> <OfficeID>2</OfficeID> <OpenDateTime>2025-12-03T12:36:01.3010852+00:00</OpenDateTime> <PaymentTerms>25</PaymentTerms> <PickupAddress1>sample string 39</PickupAddress1> <PickupAddress2>sample string 40</PickupAddress2> <PickupAddress3>sample string 41</PickupAddress3> <PickupAddressCode>sample string 37</PickupAddressCode> <PickupAddressID>1</PickupAddressID> <PickupAfterHoursNumber>sample string 49</PickupAfterHoursNumber> <PickupCityName>sample string 42</PickupCityName> <PickupCompanyName>sample string 38</PickupCompanyName> <PickupContactName>sample string 47</PickupContactName> <PickupCountryID>sample string 45</PickupCountryID> <PickupDefaultAirportID>sample string 53</PickupDefaultAirportID> <PickupDistanceToAirport>1</PickupDistanceToAirport> <PickupDistanceUOM>sample string 54</PickupDistanceUOM> <PickupEmailAddress>sample string 51</PickupEmailAddress> <PickupFaxNumber>sample string 50</PickupFaxNumber> <PickupInstructions>sample string 52</PickupInstructions> <PickupPhoneNumber>sample string 48</PickupPhoneNumber> <PickupPostalCode>sample string 44</PickupPostalCode> <PickupStateProvID>sample string 43</PickupStateProvID> <PickupTimezoneID>sample string 46</PickupTimezoneID> <ReferenceLocked>true</ReferenceLocked> <ReferenceRequired>true</ReferenceRequired> <ReferenceValue>sample string 28</ReferenceValue> <RevenueToDate>19</RevenueToDate> <RevenueYearToDate>20</RevenueYearToDate> <SalesPersonID>22</SalesPersonID> <SecurityCode>sample string 73</SecurityCode> <TaxCountryID>sample string 34</TaxCountryID> <TaxNumber>sample string 35</TaxNumber> <TaxTypeID>sample string 33</TaxTypeID> <TimezoneID>sample string 36</TimezoneID> <auth>sample string 1</auth> </CreateCustomerParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBase| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2"
}
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>