REST APIs

Avenue APIs

Get your invoices paid on time, every time.

Avenue APIs (A.K.A Pronto Connect ECommerce) help you integrate B2C ecommerce applications more efficiently with Pronto Xi. Avenue provides an integrated, single platform data extract and transfer process that is fully compatible with supported Pronto Xi versions.

About Avenue APIs

The Avenue APIs are a set of web APIs that define a set of http request messages, along with a definition of the structure of response messages, which are in the form of JSON or XML. Avenue uses a suite of APIs, including the eCommerce set, to allow developers to build custom applications such as eCommerce websites which rely on product information and order transactions within Pronto Xi.
The Avenue APIs provide you with the ability to manage your eCommerce stores by providing calls for working with resources such as customers, categories, products, and sales orders. It also allows you to manage shopping carts and inventory. Transaction data is seamlessly synchronised to Pronto Xi.

What can I achieve with Avenue APIs?

You can post transactional data such as web sales orders to Pronto Xi and receive order confirmation. Also you can send individual or bulk data requests to Pronto Xi to query information such as multi warehouse inventory quantities, product companion items, pricing, customer order history and so on.

Here’s a sample of what you can do the Avenue APIs:

Import product information from Pronto Xi
Query product availability
Create sales orders
Query order submission status
Retrieve orders from Pronto Xi
Integrate a third-party shopping cart or eCommerce application
Query product categories
Query debtors

Single platform so custom interfaces are required
There is no need for specialist Pronto Xi developer knowledge or licences
It uses authenticated http-based API calls (Pronto Web Services standard) so there is no reliance on Pronto Xi availability
Synchronisation times between Avenue and Pronto Xi is typically two minutes
It is always compatible with supported Pronto Xi versions

Using the Pronto Avenue APIs, developers don’t need to be 4GL or Pronto Xi specialists to work with and access the Pronto Xi data and business logic.

Avenue is hosted by Pronto Software and the APIs are written, installed, and supported by Pronto Software so there is no need for developers to create custom, unsupported interfaces or to obtain additional licences to develop their applications.

Before you start

Avenue APIs are designed to provide a single price only per product and is not suitable for B2B applications where price for a product may vary between customers. It is recommended to use the full Avenue eCommerce suite for B2B. Avenue APIs does not support the Pronto Xi Promotions Engine. A limit of 30 API calls per minute applies. This limit is set to ensure the right balance between quality of service and server resources. This guide provides 'out of the box' standard Avenue API features however it cannot cater for all possible requirements of all customers.

Avenue APIs

The following APIs are available:

Name

Code

Version

Method

Url

GET: Category

Standard options

updated_since DD-MM-YYYY-HH-MM
created_since DD-MM-YYYY-HH-MM
page(blank or 1 for first page
per_page per_page

JSON
XML

JSON Scheme:

{
"categories": [
{
"slug": "",
"url": "",
"public_title": ""
}
],
"count": "",
"pages": ""
}

XML Scheme:

< category >
< categories type='array' >
< category >
< slug/ >
< url/ >
< public-title/ >
< /category >
< /categories >
< count/ >
< pages/ >
< /category >

Debtor

debtor

GET

/api/(FORMAT)/debtor/v4

GET: Debtor

Standard options

updated_since DD-MM-YYYY-HH-MM
created_since DD-MM-YYYY-HH-MM
page(blank or 1 for first page
per_page per_page

Search options

account_code

JSON
XML

JSON Scheme:


{
"debtors": [
{
"code": "",
"email": "",
"fax": "",
"name": "",
"phone": "",
"territory": "",
"website": "",
"warehouse": "",
"customer_type": "",
"delivery_address": {
"address1": "",
"address2": "",
"address3": "",
"address4": "",
"address5": "",
"address6": "",
"address7": "",
"postcode": ""
}
}
],
"count": "",
"pages": ""
}

XML Scheme:


< debtor >
< debtors type='array' >
< debtor >
< code/ >
< email/ >
< fax/ >
< name/ >
< pdone/ >
< territory/ >
< website/ >
< warehouse/ >
< customer-type/ >
< delivery-address >
< address1/ >
< address2/ >
< address3/ >
< address4/ >
< address5/ >
< address6/ >
< address7/ >
< postcode/ >
< /delivery-address >
< /debtor >
< /debtors >
< count/ >
< pages/ >
< /debtor >

Error Response

error_response

GET

/api/(FORMAT)/error_response/v4

JSON
XML

JSON Scheme:


{
"message": "",
"backtrace": ""
}

XML Scheme:


< error-response >
< message >
< backtrace >
< error-response >

Order

order

GET

/api/(FORMAT)/order/v4

GET: Order

Standard options

updated_since DD-MM-YYYY-HH-MM
created_since DD-MM-YYYY-HH-MM
page(blank or 1 for first page
per_page per_page

Search options

number
suffix

JSON
XML

JSON Scheme:


{
"orders": [
{
"customer_reference": "",
"debtor": "",
"pronto_order_number": "",
"suffix": "",
"status_code": "",
"status_desc": "",
"carrier_code": "",
"consignment_note": "",
"currency_code": "",
"delivery_address": {
"address1": "",
"address2": "",
"address3": "",
"address4": "",
"address5": "",
"address6": "",
"address7": "",
"postcode": "",
"phone": ""
},
"delivery_instructions": {
"del_inst_1": "",
"del_inst_2": "",
"del_inst_3": "",
"del_inst_4": "",
"del_inst_5": "",
"del_inst_6": "",
"del_inst_7": "",
},
"payment_method": "",
"payment_reference": "",
"lines": [
{
"type": "",
"stock_code": "",
"ordered_qty": "",
"backordered_qty": "",
"shipped_qty": "",
"uom": "",
"price_ex_tax": "",
"price_inc_tax": ""
}
]
}
],
"count": "",
"pages": ""
}

XML Scheme:


< order >
< orders type='array' >
< order >
< customer-reference/ >
< debtor/ >
< pronto-order-number/ >
< suffix/ >
< status-code/ >
< status-desc/ >
< carrier-code/ >
< consignment-note/ >
< currency-code/ >
< delivery-address >
< address1/ >
< address2/ >
< address3/ >
< address4/ >
< address5/ >
< address6/ >
< address7/ >
< postcode/ >
< phone/ >
< /delivery-address >
< delivery-instructions >
< del-inst-1/ >
< del-inst-2/ >
< del-inst-3/ >
< del-inst-4/ >
< del-inst-5/ >
< del-inst-6/ >
< del-inst-7/ >
< /delivery-instructions >
< payment-method/ >
< payment-reference/ >
< lines type='array' >
< line >
< type/ >
< stock-code/ >
< ordered-qty/ >
< backordered-qty/ >
< shipped-qty/ >
< uom/ >
< price-ex-tax/ >
< price-inc-tax/ >
< /line >
< /lines >
< /order >
< /orders >
< count/ >
< pages >
< /order >

Order

order

POST

/api/(FORMAT)/order/v6

JSON Scheme:


{
"customer_reference": "",
debtor": "",
"delivery_instructions": "",
"notes": "",
"header_notes": [,
{
"type": "",
"text": ""
}
],
"delivery_address": {
"address1": "",
"address2": "",
"address3": "",
"address4": "",
"address5": "",
"address6": "",
"address7": "",
"postcode": "",
"phone": ""
},
"payment": {
"method": "",
"reference": "",
"amount": "",
"currency_code": "",
"bank_code": "",
"tax_rate_code": ""
},
"lines": [
{
"quantity": "",
"type": "",
"item_code": "",
"uom": "",
"price_ex_tax": "",
"price_inc_tax": "",
"charge_type": "",
"description": "",
"carrier_code": "",
"uom_qty": "",
"shipped": "",
"uom_shipped": "",
"back_ordered": "",
"uom_back_ordered": "",
"discount_rate": "",
"warehouse": ""
}
]
}

XML Scheme:


< order >
< customer-reference > < customer-reference >
< debtor > < /debtor >
< delivery-instructions > < /delivery-instructions >
< notes > < /notes >
< header-notes type="array" >
< header-note >
< type > < /type >
< text > < /text >
< /header-note >
< /header-notes >
< delivery-addresss >
< address1 > < /address1 >
< address2 > < /address2 >
< address3 > < /address3 >
< address4 > < /address4 >
< address5 > < /address5 >
< address6 > < /address6 >
< address7 > < /address7 >
< postcode > < /postcode >
< phone > < /phone >
< /delivery-addresss >
< payment >
< method > < /method >
< reference > < /reference >
< amount > < /amount >
< currency-code > < /currency-code >
< bank-code > < /bank-code >
< tax-rate-code > < /tax-rate-code >
< /payment >
< lines type="array" >
< line >
< quantity > < /quantity >
< type > < /type >
< item-code > < /item-code >
< uom > < /uom >
< price-ex-tax > < /price-ex-tax >
< price-inc-tax > < /price-inc-tax >
< charge-type > < /charge-type >
< description > < /description >
< carrier-code > < /carrier-code >
< uom-qty > < /uom-qty >
< shipped > < /shipped >
< uom-shipped > < /uom-shipped >
< back-ordered > < /back-ordered >
< uom-back-ordered > < /uom-back-ordered >
< discount-rate > < /discount-rate >
< warehouse > < /warehouse >
< /line >
< lines >
< /order >

Pricing

pricing

GET

/api/(FORMAT)/pricing/v6

GET: Pricing

Standard options

product_code(required)
debtor(required)
quantity

JSON
XML

JSON Scheme:


{
"debtor": "",
"product_code": "",
"quantity": "",
"breaks": [
{
"price_rule": "",
"currency_code": "",
"inc_tax": "",
"ex_tax": "",
"min_qty": "",
"max_qty": "",
"discount_rate": ""
}
],
"base_price": {
"currency_code": "",
"inc_tax": "",
"ex_tax": ""
}
}

XML Scheme:


< pricing >
< debtor/ >
< product-code/ >
< quantity/ >
< breaks type='array' >
< break >
< price-rule/ >
< currency-code/ >
< inc-tax/ >
< ex-tax/ >
< min-qty/ >
< max-qty/ >
< discount-rate/ >
< /break >
< /breaks >
< base-price >
< currency-code/ >
< inc-tax/ >
< ex-tax/ >
< /base-price >
< /pricing >

Product

product

GET

/api/(FORMAT)/product/v4

GET: Product

Standard options

updated_since DD-MM-YYYY-HH-MM
created_since DD-MM-YYYY-HH-MM
page(blank or 1 for first page
per_page per_page

Search options

code

JSON
XML

JSON Scheme:

{
"products": [
{
"code": "",
"description": "",
"abc_class": "",
"description1": "",
"description2": "",
"description3": "",
"apn": "",
"group_code": "",
"brand": "",
"condition_code": "",
"default_conversion_factor": "",
"issue_ctrl": "",
"stk_licences_rebate_flag": "",
"pack_weight": "",
"title": "",
"stock_status": "",
"sales_type": "",
"user_only_alpha20_1": "",
"user_only_alpha20_2": "",
"user_only_alpha4_1": "",
"user_only_alpha4_2": "",
"user_only_alpha4_3": "",
"user_only_alpha4_4": "",
"user_only_date1": "",
"user_only_date2": "",
"user_only_num1": "",
"user_only_num2": "",
"user_only_num3": "",
"user_only_num4": "",
"saleability": "",
"visibility": "",
"uom": "",
"pack_size": "",
"updated_at": "",
"created_at": "",
"prices": [
{
"debtor": "",
"breaks": [
{
"price_rule": "",
"currency_code": "",
"inc_tax": "",
"ex_tax": "",
"min_qty": "",
"max_qty": ""
}
],
"base_price": {
"currency_code": "",
"inc_tax": "",
"ex_tax": ""
}
}
],
"images": [
{
"filename": "",
"content_type": "",
"updated_at": "",
"url": ""
}
],
"notes": [
{
"type": "",
"note": ""
}
],
"alternative_products": [
{
"code": ""
}
],
"companion_products": [
{
"code": ""
}
],
"inventory_quantities": [
{
"warehouse": "",
"quantity": ""
}
],
"uoms": [
{
"code": "",
"conv": "",
"gtin": "",
"weight": "",
"height": "",
"width": "",
"depth": ""
}
],
"categories": [
{
"slug": "",
"url": "",
"search_url": ""
}
]
}
],
"count": "",
"pages": ""
}

XML Scheme:

<product>
<products type='array'>
<product>
<code/>
<description/>
<abc-class/>
<description1/>
<description2/>
<description3/>
<apn/>
<group-code/>
<brand/>
<condition-code/>
<default-conversion-factor/>
<issue-ctrl/>
<stk-licences-rebate-flag/>
<pack-weight/>
<title/>
<stock-status/>
<sales-type/>
<user-only-alpha20-1/>
<user-only-alpha20-2/>
<user-only-alpha4-1/>
<user-only-alpha4-2/>
<user-only-alpha4-3/>
<user-only-alpha4-4/>
<user-only-date1/>
<user-only-date2/>
<user-only-num1/>
<user-only-num2/>
<user-only-num3/>
<user-only-num4/>
<saleability/>
<visibility/>
<uom/>
<pack-size/>
<updated-at/>
<created-at/>
<prices type='array'>
<price>
<debtor/>
<breaks type='array'>
<break>
<price-rule/>
<currency-code/>
<inc-tax/>
<ex-tax/>
<min-qty/>
<max-qty/>
</break>
</breaks>
<base-price>
<currency-code/>
<inc-tax/>
<ex-tax/>
</base-price>
</price>
</prices>
<images type='array'>
<image>
<filename/>
<content-type/>
<updated-at/>
<url/>
</image>
</images>
<notes type='array'>
<note>
<type/>
<note/>
</note>
</notes>
<alternative-products type='array'>
<alternative-product>
<code/>
</alternative-product>
</alternative-products>
<companion-products type='array'>
<companion-product>
<code/>
</companion-product>
</companion-products>
<inventory-quantities type='array'>
<inventory-quantity>
<warehouse/>
<quantity/>
</inventory-quantity>
</inventory-quantities>
<uoms type='array'>
<uom>
<code/>
<conv/>
<gtin/>
<weight/>
<height/>
<width/>
<depth/>
</uom>
</uoms>
<categories type='array'>
<category>
<slug/>
<url/>
<search-url/>
</category>
</categories>
</product>
</products>
<count/>
<pages/>
</product>

Transaction

transaction

GET

/api/(FORMAT)/transaction/v5

GET: Transaction

Search options

uuid(required)

JSON
XML

JSON Scheme:


{
"apitransactions": [
{
"uuid": "",
"status": "",
"errors": "",
"warnings": "",
"result_url": ""
}
]
}

XML Scheme:


< transaction >
< apitransactions type='array' >
< apitransaction >
< uuid/ >
< status/ >
< errors/ >
< warnings/ >
< result-url/ >
< /apitransaction >
< /apitransactions >
< /transaction >

Pronto Xi Avenue powered by Pronto Woven, the digital consultancy division of Pronto Software.