Retrieve a list of clients
OData
P4W utilizes OData when querying database through API calls. Following example retrieves first 20 clients.
GET https://{tenant_name}.p4warehouse.com/odata/Client
Query Parameters
Name
Type
Description
$top
Integer
Number of clients to retrieve
$count
Boolean
Whether to displays total number of clients available
Headers
Name
Type
Description
ApiKey*
Stirng
System API key
{
"@odata.context": "https://doc1.p4warehouse.com/odata/$metadata#Client",
"@odata.count": 4,
"value": [
{
"Name": "Demo",
"CompanyName": null,
"Description": "123456789",
"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,
"SmallParcelBroker": "EasyPost",
"SmallParcelBrokerUrl": null,
"SmallParcelBrokerApiKey": null,
"SmallParcelCarrierServices": null,
"SmallParcelCarrierAccounts": null,
"SsccCompanyId": "API Demo",
"NextSsccNumber": 0,
"BolPrefix": null,
"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,
"Id": "2f97fed5-bdd4-45a1-9381-9ab5f4c0e420",
"DateCreated": "2023-08-21T20:19:26.2527275Z"
},
{
"Name": "01",
"CompanyName": null,
"Description": "DemoClient01",
"TaxId": null,
"Logo": null,
"PackslipDisclaimer": null,
"ProformaInvoiceDisclaimer": null,
"ReturnsDisclaimer": null,
"ReceivingSlipDisclaimer": null,
"Email": null,
"Phone": null,
"ContactPerson": null,
"BolHazmatMessage": null,
"ThreePLBillingEnabled": true,
"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,
"SmallParcelBroker": "EasyPost",
"SmallParcelBrokerUrl": null,
"SmallParcelBrokerApiKey": null,
"SmallParcelCarrierServices": null,
"SmallParcelCarrierAccounts": null,
"SsccCompanyId": "0123456",
"NextSsccNumber": 90,
"BolPrefix": null,
"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,
"Id": "ce54af79-2587-4053-8c65-b13734f4bf39",
"DateCreated": "2022-04-28T16:03:28.2187839Z"
},
{
"Name": "02",
"CompanyName": null,
"Description": "DemoClient02",
"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,
"SmallParcelBroker": "EasyPost",
"SmallParcelBrokerUrl": null,
"SmallParcelBrokerApiKey": null,
"SmallParcelCarrierServices": null,
"SmallParcelCarrierAccounts": null,
"SsccCompanyId": "0123457",
"NextSsccNumber": 76,
"BolPrefix": null,
"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,
"Id": "91c64445-04d0-41da-a9ce-f05c0db7d4d4",
"DateCreated": "2022-04-28T16:11:16.8693864Z"
},
{
"Name": "03",
"CompanyName": null,
"Description": "DemoClient03",
"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,
"SmallParcelBroker": "EasyPost",
"SmallParcelBrokerUrl": null,
"SmallParcelBrokerApiKey": null,
"SmallParcelCarrierServices": null,
"SmallParcelCarrierAccounts": null,
"SsccCompanyId": "0123458",
"NextSsccNumber": 0,
"BolPrefix": null,
"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,
"Id": "e21f7253-b17b-42f8-bacc-ff968df4fcfc",
"DateCreated": "2022-07-08T02:56:38.04549Z"
}
]
}Use OData syntax (https://www.odata.org/documentation/) to personalize queries through API calls.
Example of OData query
https://{tenant_name}.p4warehouse.com/odata/Client?$top=20&$count=true