8000 GitHub - erolislen/opencart-api-v1: Opencart API v1
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

erolislen/opencart-api-v1

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
catalog
catalog
 
 
README.md
README.md
 
 

Repository files navigation

Opencart API v1

This OpenCart API has been developed to interact with OpenCart stores. The API enables you to retrieve, list, delete, and update various data such as categories, customers, currencies, countries, order statuses, manufacturers, products, reports, reviews, and wishlists in your store through different endpoints. It is designed for store owners and developers who want to integrate store data with third-party applications or software.

Running Tests

To run tests, run the following command

Run in Postman

API Endpoints for Category

The following API endpoints are available for managing category related data:

Get Category

  GET /api/rest/category/getCategory
Parameter Type Description
category_id string Get the details of the category with the specified category ID.

Get Categories

  GET /api/rest/category/getCategories
Parameter Type Description
status orderby sort limit string Get the list of all categories in the store.

Delete Category

  DELETE /api/rest/category/deleteCategory
Parameter Type Description
category_id string Delete the category with the specified category ID.

API Endpoints for Customer

The following API endpoints are available for managing customer related data:

Get Customer

  GET /api/rest/customer/getCustomer
Parameter Type Description
customer_id string Get the details of the customer with the specified customer ID.

Get Customer By Email

  GET api/rest/customer/getCustomerByEmail
Parameter Type Description
email string Get the details of the customer with the specified email address.

Get Customers

  GET api/rest/customer/getCustomers
Parameter Type Description
status orderby sort limit string Get the list of all customers in the store.

Delete Customer

  DELETE /api/rest/customer/deleteCustomer
Parameter Type Description
customer_id string Delete the cu 8000 stomer with the specified customer ID.

Get Customer Group

  GET /api/rest/customer/getCustomerGroup
Parameter Type Description
customer_group_id string Get the details of the customer group with the specified customer group ID.

Get Customer Groups

  GET api/rest/customer/getCustomerGroups
Parameter Type Description
orderby sort limit string Get the list of all customer groups in the store.

API Endpoints for Localisation

The following API endpoints are available for managing localisation related data:

Get Country

  GET /api/rest/localisation/getCountry
Parameter Type Description
country_id string Get the details of the country with the specified country ID.

Get Countries

  GET /api/rest/localisation/getCountries
Parameter Type Description
status orderby sort limit string Get the list of all countries in the store.

Get Zone

  GET /api/rest/localisation/getZone
Parameter Type Description
zone_id string Get the details of the region with the specified region ID.

Get Zones By Country Id

  GET /api/rest/localisation/getZonesByCountryId
Parameter Type Description
country_id string Get the list of all regions in the specified country ID.

Get Currency By Code

  GET /api/rest/localisation/getCurrencyByCode
Parameter Type Description
code string Get the details of the currency with the specified currency code.

Get Currencies

  GET /api/rest/localisation/getCurrencies
Parameter Type Description
status orderby sort limit string Get the list of all currencies in the store.

Get Language

  GET /api/rest/localisation/getLanguage
Parameter Type Description
code string Get the details of the language with the specified language code.

Get Languages

  GET /api/rest/localisation/getLanguages
Parameter Type Description
status orderby sort limit string Get the list of all languages in the store.

Get Order Status

  GET /api/rest/localisation/getOrderStatus
Parameter Type Description
order_status_id string Get the details of the order status with the specified order status ID.

Get Order Statuses

  GET /api/rest/localisation/getOrderStatuses
Parameter Type Description
language_id orderby sort limit string Get the list of all order statuses in the store.

API Endpoints for Manufacturer

The following API endpoints are available for managing manufacturer related data:

Get Manufacturer

  GET /api/rest/manufacturer/getManufacturer
Parameter Type Description
manufacturer_id string Get the details of the manufacturer with the specified manufacturer ID.

Get Manufacturers

  GET /api/rest/manufacturer/getManufacturers
Parameter Type Description
status orderby sort limit string Get the list of all manufacturers in the store.

Get Total Manufacturers

  GET /api/rest/manufacturer/getTotalManufacturers

Get the total number of manufacturers in the store.

Delete Manufacturer

  DELETE /api/rest/manufacturer/deleteManufacturer
Parameter Type Description
manufacturer_id string Delete the manufacturer with the specified manufacturer ID.

API Endpoints for Order

The following API endpoints are available for managing order related data:

Get Order

  GET /api/rest/order/getOrder
Parameter Type Description
order_id string Retrieves the details of the specified order.

Get Orders

  GET /api/rest/order/getOrders
Parameter Type Description
order_status orderby sort limit start_date end_date string Retrieves a list of all orders in the store..

Get Order Products

  GET /api/rest/order/getOrderProducts
Parameter Type Description
order_id string Retrieves the products associated with the specified order.

Get Order Options

  GET /api/rest/order/getOrderOptions
Parameter Type Description
order_id order_product_id string Retrieves the options associated with the specified order.

Get Order Totals

  GET /api/rest/order/getOrderTotals
Parameter Type Description
order_id string Retrieves the totals associated with the specified order.

Delete Order

  DELETE /api/rest/order/deleteOrder
Parameter Type Description
order_id string Deletes the specified order.

API Endpoints for Product

The following API endpoints are available for managing product related data:

Get Product

  GET /api/rest/product/getProduct
Parameter Type Description
product_id string Get details of the product with the specified ID.

Get Products

  GET /api/rest/product/getProducts
Parameter Type Description
status orderby sort limit string Get a list of all products in the store.

Get Product Images

  GET /api/rest/product/getProductImages
Parameter Type Description
product_id string Get a list of images for the product with the specified ID.

Get Product Attributes

  GET /api/rest/product/getProductAttributes
Parameter Type Description
product_id string Get a list of attributes for the product with the specified ID.

Get Product Options

  GET /api/rest/product/getProductOptions
Parameter Type Description
order_id string Get a list of options for the product with the specified ID.

Get Popular Products

  GET /api/rest/product/getPopularProducts
Parameter Type Description
limit string Get a list of the most popular products in the store.

Get Products By Category Id

  GET /api/rest/product/getProductsByCategoryId
Parameter Type Description
category_id status limit sort orderby string Get a list of products in the specified category.

Delete Product

  DELETE /api/rest/product/deleteProduct
Parameter Type Description
product_id string Delete the product with the specified ID.

API Endpoints for Report

The following API endpoints are available for managing report related data:

Get Statistics

  GET /api/rest/report/getStatistics

Retrieves store statistics.

API Endpoints for Review

The following API endpoints are available for managing review related data:

Get Reviews By Product Id

  GET /api/rest/review/getReviewsByProductId
Parameter Type Description
product_id string Retrieves all comments with the specified product ID.

Get Total Reviews By Product Id

  GET /api/rest/review/getTotalReviewsByProductId
Parameter Type Description
product_id string Returns the total number of reviews with the specified product ID.

API Endpoints for Whishlist

The following API endpoints are available for managing whishlist related data:

Get Wishlist

  GET /api/rest/wishlist/getWishlist
Parameter Type Description
customer_id string Retrieves the wishlist of the customer with the specified customer ID.

Get Total Wishlist

  GET /api/rest/wishlist/getTotalWishlist
Parameter Type Description
customer_id string Returns the total number of wishlists for the customer with the specified customer ID.

Support

For support, email support@erolislen.com.tr

Feedback

If you have any feedback, please reach out to us at support@erolislen.com.tr

About

Opencart API v1

Resources

Readme
Activity

Stars

12 stars

Watchers

2 watching

Forks

7 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages
0