Read Vendor
Retrieves the details of a Vendor object that has been previously created.
Parameters
Path Params | |
---|---|
yourCompany: | string |
Query Params | |
---|---|
filter: | string
https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorName,eq,Robert Smith;Test CheckBox,eq,no&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=CreatedTime,bt,01-15-2020 | 01-31-2020&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=CreatedTime,bt,01-15-2020 01:03:10| 01-31-2020 20:00:00&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=Status,eq,Vendor OR Other&key=xyzkey
https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorId,eq,3422&key=xyzkey List of condition abbrevations to be used: |
customview: | string https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?customview=ABC Customview&key=xyzkey |
page: | int https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorName,eq,Robert Smith;Test CheckBox,eq,no&page=10&key=xyzkey |
pageSize: | int https://xyzcompany.agiliron.net/agiliron/api-40/Vendor?filter=VendorName,eq,Robert Smith;Test CheckBox,eq,no&pageSize=10&key=xyzkey |
Header Params | |
---|---|
Accept: | string |
Query Auth | |
---|---|
key: | string |
Header Auth | |
---|---|
apiKey: | string |
Sample Code
{
"Vendors": {
"Vendor": [{
"VendorId": "3422",
"VendorName": "Test New Vendor",
"AccountNumber": "659846",
"ParentCompany": "Test New Vendor",
"PrimaryContact": "Contact1",
"OtherPhone": "56984663",
"OtherEmail": "[email protected]",
"Category": "Other",
"Fax": "5689746",
"Website": "www.abc.com",
"Rating": "Good",
"AssignedToUser": "admin",
"Type": "Vendor",
"TaxAuthority": "Indiana State",
"CreditLimit": "1000.000",
"CreditLimitExpires": "01-24-2020",
"PriceBook": "Test New Vendor - Vendor",
"DefaultCurrency": "USD",
"Discount": "10",
"PaymentMethod": "Cash",
"TermsAndConditions": "",
"Carrier": "Not Specified25",
"ShippingMethod": "???",
"DeliverTo": "OAK",
"Street": "1515 Clay Street",
"City": "Oakland",
"Postcode": "94624",
"State": "CA",
"Country": "United States",
"Telephone": "56412356",
"Email": "[email protected]",
"Description": "The Description Goes here.",
"CreatedTime": "01-24-2020 05:19:56",
"CreatedTimeUTC": "01-24-2020 15:01:35",
"ModifiedTime": "01-24-2020 05:19:56",
"ModifiedTimeUTC": "01-24-2020 15:05:56",
"VendorCustomFields": {
"CustomField": [{
"Name": "CustomFied1",
"Value": "Custom info 1"
},
{
"Name": "CustomFied2",
"Value": "Custom info 2"
}
]
}
}],
"TotalRecords": "1",
"CurrentPage": "1",
"TotalPages": "1",
"PageSize": "50"
}
}
<Vendors>
<Vendor>
<VendorId>3422</VendorId>
<VendorName>Test New Vendor</VendorName>
<AccountNumber>659846</AccountNumber>
<ParentCompany>Test New Vendor</ParentCompany>
<PrimaryContact>Contact1</PrimaryContact>
<OtherPhone>56984663</OtherPhone>
<OtherEmail>[email protected]</OtherEmail>
<Category>Other</Category>
<Fax>5689746</Fax>
<Website>www.abc.com</Website>
<Rating>Good</Rating>
<AssignedToUser>admin</AssignedToUser>
<Type>Vendor</Type>
<TaxAuthority>Indiana State</TaxAuthority>
<CreditLimit>1000.000</CreditLimit>
<CreditLimitExpires>01-24-2020</CreditLimitExpires>
<PriceBook>Test New Vendor - Vendor</PriceBook>
<DefaultCurrency>USD</DefaultCurrency>
<Discount>10</Discount>
<PaymentMethod>Cash</PaymentMethod>
<TermsAndConditions></TermsAndConditions>
<Carrier>Not Specified25</Carrier>
<ShippingMethod>???</ShippingMethod>
<DeliverTo>OAK</DeliverTo>
<Street>1515 Clay Street</Street>
<City>Oakland</City>
<Postcode>94624</Postcode>
<State>CA</State>
<Country>United States</Country>
<Telephone>56412356</Telephone>
<Email>[email protected]</Email>
<Description>The Description Goes here.</Description>
<CreatedTime>01-24-2020 05:19:56</CreatedTime>
<CreatedTimeUTC>01-24-2020 15:01:35</CreatedTimeUTC>
<ModifiedTime>01-24-2020 05:19:56</ModifiedTime>
<ModifiedTimeUTC>01-24-2020 15:05:56</ModifiedTimeUTC>
<VendorCustomFields>
<CustomField>
<Name>CustomFied1</Name>
<Value>Custom info 1</Value>
</CustomField>
<CustomField>
<Name>CustomFied2</Name>
<Value>Custom info 2</Value>
</CustomField>
</VendorCustomFields>
</Vendor>
<TotalRecords>1</TotalRecords>
<CurrentPage>1</CurrentPage>
<TotalPages>1</TotalPages>
<PageSize>50</PageSize>
</Vendors>
WADL
<?xml version="1.0" encoding="utf-8"?>
<application>
<resources base="https://{yourCompany}.agiliron.net/agiliron/api-40">
<resource path="Vendor">
<method name="GET">
<resource path="{VendorId/VendorName/Email}">
<request>
<param name="key" type="xsd:string" style="query" required="true"/>
</request>
<response status="200">
<representation mediaType="application/xml" element="yn:ResultSet"/>
</response>
<response status="400">
<representation mediaType="application/xml" element="ya:Error"/>
</response>
</method>
</resource>
</resources>
</application>
Updated about 21 hours ago