marketplaceapi 1.0.3

A Marketplace API developed by FromTheInternet

marketplace-api #

A Marketplace API using OAuth2 for applications developed by FromTheInternet

Requirements #

Dart 1.20.0 or later OR Flutter 0.0.20 or later

Installation & Usage #

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

name: marketplace-api
version: 1.0.0
description: A Marketplace API developed by FromTheInternet
dependencies:
  marketplace-api:
    git: https://github.com//.git
      version: 'any'

Local #

To use the package in your local drive, please include the following in pubspec.yaml

dependencies:
  marketplace-api:
    path: /path/to/marketplace-api

Tests #

TODO

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:marketplace-api/api.dart';

// TODO Configure OAuth2 access token for authorization: application
//marketplace-api.api.Configuration.accessToken = 'YOUR_ACCESS_TOKEN';

var api_instance = new BasketsApi();
var basketId = basketId_example; // String | Assigned Id of the basket you are deleting.

try {
    api_instance.basketsBasketIdDelete(basketId);
} catch (e) {
    print("Exception when calling BasketsApi->basketsBasketIdDelete: $e\n");
}

Documentation for API Endpoints #

ClassMethodHTTP requestDescription
BasketsApibasketsBasketIdDeleteDELETE /baskets/{basketId}Delete basket in marketplace
BasketsApibasketsBasketIdGetGET /baskets/{basketId}Get basket
BasketsApibasketsBasketIdPutPUT /baskets/{basketId}Replace basket
BasketsApibasketsGetGET /basketsGet all baskets
BasketsApibasketsPostPOST /basketsAdd basket
BasketsApibasketsProductProductIdDeleteDELETE /baskets/product/{productId}Delete baskets with product Id in marketplace
CategoriesApicategoriesCategoryIdDeleteDELETE /categories/{categoryId}Delete category
CategoriesApicategoriesCategoryIdGetGET /categories/{categoryId}Get Category by Id
CategoriesApicategoriesCategoryIdPutPUT /categories/{categoryId}Replace category
CategoriesApicategoriesGetGET /categoriesGet all categories
CategoriesApicategoriesPostPOST /categoriesAdd category
CustomersApicustomersCustomerIdDeleteDELETE /customers/{customerId}Delete Customer in marketplace
CustomersApicustomersCustomerIdGetGET /customers/{customerId}Get Customer
CustomersApicustomersCustomerIdPutPUT /customers/{customerId}Replace Customer
CustomersApicustomersGetGET /customersGet all Customers
CustomersApicustomersPostPOST /customersAdd Customer
OrdersApiorderOrderIdDeleteDELETE /order/{orderId}Delete Order in marketplace
OrdersApiorderOrderIdGetGET /order/{orderId}Get Order
OrdersApiorderOrderIdPutPUT /order/{orderId}Replace Order
OrdersApiorderStatusStatusGetGET /order/status/{status}Get All Orders with status
OrdersApiordersGetGET /ordersGet all Orders
OrdersApiordersPostPOST /ordersAdd order
ProductsApiproductsCategoryCategoryIdGetGET /products/category/{categoryId}Get product by category Id
ProductsApiproductsGetGET /productsGet all products
ProductsApiproductsPostPOST /productsAdd product
ProductsApiproductsProductIdDeleteDELETE /products/{productId}Delete product in marketplace
ProductsApiproductsProductIdGetGET /products/{productId}Get product
ProductsApiproductsProductIdPutPUT /products/{productId}Replace product
StoresApistoresGetGET /storesGet all Stores
StoresApistoresPostPOST /storesAdd store
StoresApistoresStoreIdDeleteDELETE /stores/{storeId}Delete store
StoresApistoresStoreIdGetGET /stores/{storeId}Get store by Id
StoresApistoresStoreIdPutPUT /stores/{storeId}Replace store
TagsApitagsGetGET /tagsGet all Tags
TagsApitagsPostPOST /tagsAdd Tag
TagsApitagsTagIdDeleteDELETE /tags/{tagId}Delete Tag in marketplace
TagsApitagsTagIdGetGET /tags/{tagId}Get Tag
TagsApitagsTagIdPutPUT /tags/{tagId}Replace Tag

Documentation For Models #

Documentation For Authorization #

application #

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • write: allows modifying resources
  • read: allows reading resources

Author #

info@fromtheinternet.co.za

0
likes
40
pub points
0%
popularity

Publisher

fromtheinternet.co.za

A Marketplace API developed by FromTheInternet

Homepage

Documentation

Documentation
API reference

License

MIT (LICENSE)

Dependencies

http

More

Packages that depend on marketplaceapi