GET 3dCartWebAPI/v1/Distributors/{id}

Get a Distributor

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Distributor ID	integer	Required

Body Parameters

None.

Sample Request

PHP

Python

Ruby

Please click here to download the C# Rest API Client project from GitHub.

not yet available

Response Information

Resource Description

Collection of Distributor

Name	Description	Type	Additional information
DistributorID	database reference = distributors.id	integer	None.
CompanyName	database reference = distributors.company	string	Required String length: inclusive between 0 and 50
ContactName	database reference = distributors.contact	string	String length: inclusive between 0 and 50
Address	database reference = distributors.address	string	String length: inclusive between 0 and 50
Address2	database reference = distributors.address2	string	String length: inclusive between 0 and 50
City	database reference = distributors.city	string	String length: inclusive between 0 and 50
State	database reference = distributors.state	string	String length: inclusive between 0 and 50
Zip	database reference = distributors.zip	string	String length: inclusive between 0 and 50
Country	database reference = distributors.country	string	String length: inclusive between 0 and 50
Phone	database reference = distributors.telephone	string	String length: inclusive between 0 and 50
Fax	database reference = distributors.fax	string	String length: inclusive between 0 and 50
Email	database reference = distributors.email	string	String length: inclusive between 0 and 50
Comments	database reference = distributors.comments	string	String length: inclusive between 0 and 65535
NotifyOnNewOrder	database reference = distributors.isdropshipper	boolean	None.
NotifyOnNewOrderEmailSubject	database reference = distributors.emailsubject	string	String length: inclusive between 0 and 250
NotifyOnNewOrderEmailMessage	database reference = distributors.emailmessage	string	String length: inclusive between 0 and 65535
UserID	database reference = distributors.userid	string	String length: inclusive between 0 and 50
LastUpdate	database reference = distributors.last_update	date	None.
IsDropShipper	database reference = distributors.iswarehouse	boolean	None.
NotifyOnCancelledOrder	database reference = distributors.sendcancelemail	boolean	None.
NotifyOnCancelledOrderEmailSubject	database reference = distributors.cancelemailsubject	string	String length: inclusive between 0 and 250
NotifyOnCancelledOrderEmailMessage	database reference = distributors.cancelemailmessage	string	String length: inclusive between 0 and 65535
POStyle	database reference = distributors.PO_Style	integer	None.
POEmailNotification	database reference = distributors.PO_IsEmailNotification	boolean	None.
POShippingInfo	database reference = distributors.PO_shipping_info	string	String length: inclusive between 0 and 65535
POPaymentInfo	database reference = distributors.PO_payment_info	string	String length: inclusive between 0 and 65535
POAdditionalNotes	database reference = distributors.PO_additional_notes	string	String length: inclusive between 0 and 65535
POEmailSubject	database reference = distributors.PO_email_subject	string	String length: inclusive between 0 and 250

Response Formats

application/json, text/json

Sample:

[
  {
    "DistributorID": 1,
    "CompanyName": "sample string 1",
    "ContactName": "sample string 2",
    "Address": "sample string 3",
    "Address2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "Country": "sample string 8",
    "Phone": "sample string 9",
    "Fax": "sample string 10",
    "Email": "sample string 11",
    "Comments": "sample string 12",
    "NotifyOnNewOrder": true,
    "NotifyOnNewOrderEmailSubject": "sample string 13",
    "NotifyOnNewOrderEmailMessage": "sample string 14",
    "UserID": "sample string 15",
    "LastUpdate": "04/14/2024 09:31",
    "IsDropShipper": true,
    "NotifyOnCancelledOrder": true,
    "NotifyOnCancelledOrderEmailSubject": "sample string 16",
    "NotifyOnCancelledOrderEmailMessage": "sample string 17",
    "POStyle": 1,
    "POEmailNotification": true,
    "POShippingInfo": "sample string 18",
    "POPaymentInfo": "sample string 19",
    "POAdditionalNotes": "sample string 20",
    "POEmailSubject": "sample string 21"
  },
  {
    "DistributorID": 1,
    "CompanyName": "sample string 1",
    "ContactName": "sample string 2",
    "Address": "sample string 3",
    "Address2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "Country": "sample string 8",
    "Phone": "sample string 9",
    "Fax": "sample string 10",
    "Email": "sample string 11",
    "Comments": "sample string 12",
    "NotifyOnNewOrder": true,
    "NotifyOnNewOrderEmailSubject": "sample string 13",
    "NotifyOnNewOrderEmailMessage": "sample string 14",
    "UserID": "sample string 15",
    "LastUpdate": "04/14/2024 09:31",
    "IsDropShipper": true,
    "NotifyOnCancelledOrder": true,
    "NotifyOnCancelledOrderEmailSubject": "sample string 16",
    "NotifyOnCancelledOrderEmailMessage": "sample string 17",
    "POStyle": 1,
    "POEmailNotification": true,
    "POShippingInfo": "sample string 18",
    "POPaymentInfo": "sample string 19",
    "POAdditionalNotes": "sample string 20",
    "POEmailSubject": "sample string 21"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDistributor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Distributor>
    <DistributorID>1</DistributorID>
    <CompanyName>sample string 1</CompanyName>
    <ContactName>sample string 2</ContactName>
    <Address>sample string 3</Address>
    <Address2>sample string 4</Address2>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
    <Country>sample string 8</Country>
    <Phone>sample string 9</Phone>
    <Fax>sample string 10</Fax>
    <Email>sample string 11</Email>
    <Comments>sample string 12</Comments>
    <NotifyOnNewOrder>true</NotifyOnNewOrder>
    <NotifyOnNewOrderEmailSubject>sample string 13</NotifyOnNewOrderEmailSubject>
    <NotifyOnNewOrderEmailMessage>sample string 14</NotifyOnNewOrderEmailMessage>
    <UserID>sample string 15</UserID>
    <LastUpdate>2024-04-14T09:31:09.6397952-04:00</LastUpdate>
    <IsDropShipper>true</IsDropShipper>
    <NotifyOnCancelledOrder>true</NotifyOnCancelledOrder>
    <NotifyOnCancelledOrderEmailSubject>sample string 16</NotifyOnCancelledOrderEmailSubject>
    <NotifyOnCancelledOrderEmailMessage>sample string 17</NotifyOnCancelledOrderEmailMessage>
    <POStyle>1</POStyle>
    <POEmailNotification>true</POEmailNotification>
    <POShippingInfo>sample string 18</POShippingInfo>
    <POPaymentInfo>sample string 19</POPaymentInfo>
    <POAdditionalNotes>sample string 20</POAdditionalNotes>
    <POEmailSubject>sample string 21</POEmailSubject>
  </Distributor>
  <Distributor>
    <DistributorID>1</DistributorID>
    <CompanyName>sample string 1</CompanyName>
    <ContactName>sample string 2</ContactName>
    <Address>sample string 3</Address>
    <Address2>sample string 4</Address2>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <Zip>sample string 7</Zip>
    <Country>sample string 8</Country>
    <Phone>sample string 9</Phone>
    <Fax>sample string 10</Fax>
    <Email>sample string 11</Email>
    <Comments>sample string 12</Comments>
    <NotifyOnNewOrder>true</NotifyOnNewOrder>
    <NotifyOnNewOrderEmailSubject>sample string 13</NotifyOnNewOrderEmailSubject>
    <NotifyOnNewOrderEmailMessage>sample string 14</NotifyOnNewOrderEmailMessage>
    <UserID>sample string 15</UserID>
    <LastUpdate>2024-04-14T09:31:09.6397952-04:00</LastUpdate>
    <IsDropShipper>true</IsDropShipper>
    <NotifyOnCancelledOrder>true</NotifyOnCancelledOrder>
    <NotifyOnCancelledOrderEmailSubject>sample string 16</NotifyOnCancelledOrderEmailSubject>
    <NotifyOnCancelledOrderEmailMessage>sample string 17</NotifyOnCancelledOrderEmailMessage>
    <POStyle>1</POStyle>
    <POEmailNotification>true</POEmailNotification>
    <POShippingInfo>sample string 18</POShippingInfo>
    <POPaymentInfo>sample string 19</POPaymentInfo>
    <POAdditionalNotes>sample string 20</POAdditionalNotes>
    <POEmailSubject>sample string 21</POEmailSubject>
  </Distributor>
</ArrayOfDistributor>