Create new client

End Point

'CreateOrUpdate' API end point is used to create new clients.

POST https://{tenant_name}.p4warehouse.com/api/ClientApi/CreateOrUpdate

Headers

Name	Type	Description
ApiKey*	String	System API key

Request Body

Name	Type	Description
"Name"*	String	Client name assigned by the user

200: OK Client is created

{
    "$id": "1",
    "Name": "Demo",
    "CompanyName": null,
    "Description": null,
    "TaxId": null,
    "Logo": null,
    "PackslipDisclaimer": null,
    "ProformaInvoiceDisclaimer": null,
    "ReturnsDisclaimer": null,
    "ReceivingSlipDisclaimer": null,
    "Email": null,
    "Phone": null,
    "ContactPerson": null,
    "BolHazmatMessage": null,
    "ThreePLBillingEnabled": false,
    "IsPrintPackslipOnShip": null,
    "IsPrintTruckLoadOnSign": null,
    "IsGeneratePickTicketBackOrder": null,
    "IsGeneratePoBackOrder": null,
    "IsEmailPackslips": null,
    "PackslipToEmails": null,
    "PackslipCcEmails": null,
    "PackslipBccEmails": null,
    "PackslipEmailSubject": null,
    "PackslipEmailBody": null,
    "IsEmailReceivingSlips": null,
    "ReceivingSlipToEmails": null,
    "ReceivingSlipCcEmails": null,
    "ReceivingSlipBccEmails": null,
    "ReceivingSlipEmailSubject": null,
    "ReceivingSlipEmailBody": null,
    "IsEmailCustomerReturnSlips": null,
    "CustomerReturnToEmails": null,
    "CustomerReturnCcEmails": null,
    "CustomerReturnBccEmails": null,
    "CustomerReturnEmailSubject": null,
    "CustomerReturnEmailBody": null,
    "IsEmailBols": null,
    "BolToEmails": null,
    "BolCcEmails": null,
    "BolBccEmails": null,
    "BolEmailSubject": null,
    "BolEmailBody": null,
    "SmallParcelBrokerEnum": 1,
    "SmallParcelBroker": "EasyPost",
    "SmallParcelBrokerUrl": null,
    "SmallParcelBrokerApiKey": null,
    "SmallParcelCarrierServices": null,
    "SmallParcelCarrierAccounts": null,
    "SsccCompanyId": null,
    "NextSsccNumber": 0,
    "BolPrefix": null,
    "Products": [],
    "ProductBundles": [],
    "PurchaseOrders": [],
    "Vendors": [],
    "Users": [],
    "Invoices": [],
    "BillingProfiles": [],
    "Zones": [],
    "Bins": [],
    "Info1": null,
    "Info2": null,
    "Info3": null,
    "Info4": null,
    "Info5": null,
    "Info6": null,
    "Info7": null,
    "Info8": null,
    "Info9": null,
    "Info10": null,
    "Address1": null,
    "Address2": null,
    "City": null,
    "StateProvince": null,
    "ZipPostalCode": null,
    "Country": null,
    "AddressHash": "",
    "Id": "2f97fed5-bdd4-45a1-9381-9ab5f4c0e420",
    "DateCreated": "2023-08-21T20:19:26.2527275+00:00",
    "TypeName": "Pro4Soft.TenantData.Entities.Business.Client3PL.Client",
    "TypeNameShort": "Client"

406: Not Acceptable Duplicate client/Missing fields

Cannot insert duplicate key row in object 'dbo.Clients' with unique index 'IX_Name'. The duplicate key value is (Demo).
The statement has been terminated.

```
[Name]: The Name field is required.

401: Unauthorized Incorrect API key

404: Not Found Incorrect URL

Newly created clients are assigned with 'Id' number. Use this number to further update/edit selected clients.

JSON Example

Here is an example of a JSON payload to create new client with name, description, company name, and contact person.

{
  "Name":"1234",
  "ComapyName":"E&F",
  "Description":"API Demo",
  "ContactPerson":"J.Smith"
}