POST api/Customer

Request Information

URI Parameters

None.

Body Parameters

CustomerParm
NameDescriptionTypeAdditional information
auth

string

None.

AccountNumber

string

None.

Name

string

None.

SalesPersonID

integer

None.

CustomerClassID

integer

None.

OfficeID

integer

None.

ShowDeleted

boolean

None.

CustomerGroupID

integer

None.

InvoiceFormID

integer

None.

ARAccountNumber

string

None.

BillToAccountNumber

string

None.

NextSalesReview

date

None.

BillingCycleID

integer

None.

EdiEnabled

string

None.

EdiStatusEnabled

string

None.

CityName

string

None.

StateProvID

string

None.

CountryID

string

None.

OverCreditLimit

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "auth": "sample string 1",
  "AccountNumber": "sample string 2",
  "Name": "sample string 3",
  "SalesPersonID": 1,
  "CustomerClassID": 1,
  "OfficeID": 1,
  "ShowDeleted": true,
  "CustomerGroupID": 1,
  "InvoiceFormID": 1,
  "ARAccountNumber": "sample string 5",
  "BillToAccountNumber": "sample string 6",
  "NextSalesReview": "2024-09-19T09:13:57.4520055+00:00",
  "BillingCycleID": 1,
  "EdiEnabled": "sample string 7",
  "EdiStatusEnabled": "sample string 8",
  "CityName": "sample string 9",
  "StateProvID": "sample string 10",
  "CountryID": "sample string 11",
  "OverCreditLimit": true
}

application/xml, text/xml

Sample:
<CustomerParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <ARAccountNumber>sample string 5</ARAccountNumber>
  <AccountNumber>sample string 2</AccountNumber>
  <BillToAccountNumber>sample string 6</BillToAccountNumber>
  <BillingCycleID>1</BillingCycleID>
  <CityName>sample string 9</CityName>
  <CountryID>sample string 11</CountryID>
  <CustomerClassID>1</CustomerClassID>
  <CustomerGroupID>1</CustomerGroupID>
  <EdiEnabled>sample string 7</EdiEnabled>
  <EdiStatusEnabled>sample string 8</EdiStatusEnabled>
  <InvoiceFormID>1</InvoiceFormID>
  <Name>sample string 3</Name>
  <NextSalesReview>2024-09-19T09:13:57.4520055+00:00</NextSalesReview>
  <OfficeID>1</OfficeID>
  <OverCreditLimit>true</OverCreditLimit>
  <SalesPersonID>1</SalesPersonID>
  <ShowDeleted>true</ShowDeleted>
  <StateProvID>sample string 10</StateProvID>
  <auth>sample string 1</auth>
</CustomerParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CustomerResp
NameDescriptionTypeAdditional information
IsSuccessful

boolean

None.

ErrorMessage

string

None.

Customers

Collection of CustomerItem

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Customers": null
}

application/xml, text/xml

Sample:
<CustomerResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
  <Customers i:nil="true" />
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</CustomerResp>