Skip to main content

Autoecat Pricecheck API

1. Revision History

 

Version

Date

Author

Update

1.0.0

06/01/2016

Jim Potter

-       API release

 

2. General Overview

The autoecat.com stockcheck API allows third-party warehouses to reply with stock availability when autoecat.com Jobber and installer users browse application parts.

2.1    Basic autoecat.com stock check web service functionality

At this time, the autoecat.com web service for third parties utilizes only a stock / price check capability. This provides our users with the information they need in order to make a decision on where to purchase the product. Further capabilities have been explored, but has not been seen as a required function by the autoecat.com user base.

 

3. Transaction API

3.1    Overview

In order for third-party systems to utilize the integrated features of JDISPATCH, they must utilize the JDISPATCH Transaction API, which allows third-party systems to create dispatch requests, and accept back subsequent delivery confirmations and signatures. The two transaction types utilized are a dispatch transaction and a delivery transaction

3.2    Basic autoecat.com API transaction architecture

At this time, the autoecat.com pricecheck API is only handling the process of requesting stock and pricing of an item. Ordering has been left in the hands of the Jobber to make a decision on where to source a part from.

  1. Quotes: This is the process of requesting stock and price from a supplier for a given item

3.3    Document Structure

The information passed within an autoecat.com API document can be sent via XM. All necessary information within an autoecat.com API document is contained within an element tag defined by the type of document being sent. Empty elements are allowed within an autoecat.com API document and will be ignored upon document validation on the autoecat.com server.

AMS has done their best to select semantic element names to avoid confusion when translating documents. Also, all tag names use Camel Case, indicating that the first letter of each word will be capitalized, and all subsequent letters are lower case. 

3.4    XML Schema

Each of the autoecat.com document layouts are described in an XML schema document, or, template. If you are unfamiliar with a schema document, the W3C site provides more information on this topic here: http://www.w3.org/standards/xml/schema. Detailed schemas are listed in Appendix B.

3.5    Document Sections

Each document contains 3 basic elements, a root which will be named by the transaction type, either a <RequestForQuote> or a <Quote>, and then contain a <Header> element and a <Lines> element.

3.6    Header

The header of each document contains identifying information that validates the request and the user sending the request. The required information will not change, regardless of the document type being used. The following attributes will exist on each request document, and need to be included in the response. However, the tags may be left empty if no suitable value is available. Tags that can be left empty will be marked as 'Optional' below

 

Attribute

Required

Description           

Language

Required

Language of the response

Currency

Required

Currency of the selling price

DimensionalUOM

Required

General Unit Of Measure to be used in any dimensional values

WeightUOM

Required

General Unit Of Measure to be used in any weight values

 

DocumentDateTime

Required

Full Datestamp of the request

DocumentIds

Required

Unique identifiers of the document being sent

TransportationTermCode

Optional

Transportation terms applicable to the quote (Not currently used)

FreightTerms

Optional

Terms of freight on a quote request (Not currently used)

AdditionalCharges

Optional

Contains any additional charges that may be included in a quote

BillToParty

Required

Account information of the requestor

HostParty

Required

 

 

3.7    Document Types

Document

Description           

RequestForQuote

Document to request price and availability

Quote

Response to a RequestFromQuote

3.8    Lines

The <Lines> element will contain the pertinent part detail information for the request, and additional values in the response. By design, the autoecat.com RequestForQuote document will only contain a single item per request.

Request Values

Attribute

Required

Description           

LineNumber

Required

Line number of the item in the request (will always be 1)

CustomerItemID

Required

Part number

ManufacturerCode

Required

Code to describe the manufacturer of the requested part

OrderQuantity

Required

Quantity Requestes

 
Response Values

Attribute

Required

Description           

LineNumber

Required

Line number of the item in the request (will always be 1)

CustomerItemID

Required

Part number as defined by the buyer

SupplierItemID

Required

Part Number as defined by the supplier

ManufacturerCode

Required

Code to describe the manufacturer of the requested part

ManufacturerName

Required

Name of the part manufacturer

Description

Required

Product Description

ItemStatusChange

Required

Status of the item. Information on available values is in Appendix B

PriceType

Required

Type code of the price being passed. Information on these codes is in Appendix C

Price

Required

Price value of the price being passed

Full XML document examples with nested values and layout can be found in Appendix A.

 

4. Transaction Overviews

This section will give a general outline of each of the unique transaction types. For detailed XML examples, please refer to Appendix A.

4.1    Request Transaction Type Overviews

RequestForQuote: The RequestForQuote transaction is the initial request for stock and pricing of an item. At this time, this is the only document type passed via this API

4.2    Response Transaction Type Overviews

Quote: The Quote document is the standard response to a RequestForQuote and is the only response document accepted by this API at this time

4.3    Notable Field Limits

CustomerID – Alpha/Numeric, Limit 6 characters.

 

5. Appendix A

5.1 XML Response Transaction Examples

RequestForQuote
<RequestForQuote>
	<Header>
		<Language>en</Language>
		<Currency>CAD</Currency>
		<DimensionalUOM>IN</DimensionalUOM>
		<WeightUOM>LB</WeightUOM>
		<DocumentDateTime>2020-01-14T14:45:57+00:00</DocumentDateTime>
		<DocumentIds>
			<CustomerDocumentId>7317B260-EC0B-4A83-AFD3-303160F40C66</CustomerDocumentId>
		</DocumentIds>
		<TransportationTermCode>
			<issuingAgency></issuingAgency>
		</TransportationTermCode>
		<FreightTerms>
			<FreightTerm>
				<CommonCarrier freightTermCode=""/>
				<ShippingMethod freightTermCode=""/>
				<TransportationMethod freightTermCode=""/>
			</FreightTerm>
		</FreightTerms>
		<AdditionalCharges>
			<AdditionalCharge>
				<Description>ADDITIONAL CHARGE</Description>
				<Total>0.00</Total>
			</AdditionalCharge>
		</AdditionalCharges>
		<BillToParty>
			<PartyId>815638</PartyId>
			<Name></Name>
			<AddressLine></AddressLine>
			<City></City>
			<StateOrProvince></StateOrProvince>
			<PostalCode></PostalCode>
			<Country></Country>
		</BillToParty>
		<HostParty>
			<PartyId>001</PartyId>
		</HostParty>
	</Header>
	<Lines>
		<Line>
			<LineNumber>1</LineNumber>
			<OrderItem>
				<CustomerItemId>101467</CustomerItemId>
				<ManufacturerCode>PRO</ManufacturerCode>
			</OrderItem>
			<OrderQuantity uom="EA">1</OrderQuantity>
		</Line>
	</Lines>
</RequestForQuote>

5.2    XML Response Transaction Examples

Quote
<Quote>
	<Header>
		<Language>en</Language>
		<Currency>CAD</Currency>
		<DimensionalUOM>IN</DimensionalUOM>
		<WeightUOM>LB</WeightUOM>
		<DocumentDateTime>2021-01-11T07:52:17-07:00</DocumentDateTime>
		<DocumentIds>
			<CustomerRFQDocumentId>C7F49D23-6B60-43D7-8626-F5C2685B4364</CustomerRFQDocumentId>
			<SupplierDocumentID>180DDF34-D4E5-42FA-AB37-EB7C98AE9A86</SupplierDocumentID>
		</DocumentIds>
		<BillToParty>
			<PartyId>815638</PartyId>
			<Name/>
			<AddressLine/>
			<City/>
			<StateOrProvince/>
			<PostalCode/>
			<Country/>
		</BillToParty>
		<HostParty>
			<PartyId>001</PartyId>
		</HostParty>
	</Header>
	<Lines>
		<Line>
			<LineNumber>1</LineNumber>
			<OrderItem>
				<CustomerItemId>211467</CustomerItemId>
				<SupplierItemId>211467</SupplierItemId>
				<ManufacturerCode>PRO</ManufacturerCode>
				<ManufacturerName>PROMAX PADS</ManufacturerName>
				<Description>PM CERAMIC PADS WHW</Description>
			</OrderItem>
			<OrderQuantity>1</OrderQuantity>
			<ItemStatusChanges>
				<ItemStatusChange>
					<To>OK</To>
					<Description>Success</Description>
				</ItemStatusChange>
			</ItemStatusChanges>
			<Prices>
				<Pricing>
					<PriceType>NET</PriceType>
					<Price>53.64</Price>
				</Pricing>
				<Pricing>
					<PriceType>LST</PriceType>
					<Price>53.64</Price>
				</Pricing>
				<Pricing>
					<PriceType>COR</PriceType>
					<Price>0.00</Price>
				</Pricing>
			</Prices>
			<AvailQuantity>3</AvailQuantity>
		</Line>
	</Lines>
</Quote>

 

6. Appendix B

6.1    Item Status Codes

The status codes below are used to report the status of the items sent in a <Quote> doument

Status Code

Description

OK

Success

INVALID

Invalid Part. Not Found

ALT

Alternate Part

 

7. Appendix C

7.1    Price Codes

Code

Description

NET

Customer Net Selling Price

LST

List / Retail Price

 

Back to top