Skip to content

Latest commit

 

History

History
173 lines (124 loc) · 5.94 KB

README.md

File metadata and controls

173 lines (124 loc) · 5.94 KB
Raw

Inventory-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>Inventory-client</groupId>
    <artifactId>Inventory-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "Inventory-client:Inventory-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/Inventory-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import InventoryClient.*;
import InventoryClient.auth.*;
import InventoryClient.model.*;
import InventoryClient.Api.DefaultApi;

import java.io.File;
import java.util.*;

public class DefaultApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: APIKey
        ApiKeyAuth APIKey = (ApiKeyAuth) defaultClient.getAuthentication("APIKey");
        APIKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //APIKey.setApiKeyPrefix("Token");

        // Configure API key authorization: AccountID
        ApiKeyAuth AccountID = (ApiKeyAuth) defaultClient.getAuthentication("AccountID");
        AccountID.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //AccountID.setApiKeyPrefix("Token");

        DefaultApi apiInstance = new DefaultApi();
        try {
            List<InventoryGroup> result = apiInstance.allGet();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DefaultApi#allGet");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://www.orkiv.com/i/api

Class Method HTTP request Description
DefaultApi allGet GET /all/
DefaultApi categoriesDelete DELETE /categories/
DefaultApi categoriesPost POST /categories/
DefaultApi categoriesPut PUT /categories/
DefaultApi itemAddPost POST /item/add/
DefaultApi itemAddbulkPost POST /item/addbulk/
DefaultApi itemDelete DELETE /item/
DefaultApi itemGet GET /item/
DefaultApi itemMediaDelete DELETE /item-media/
DefaultApi itemMediaPost POST /item-media/
DefaultApi itemPut PUT /item/
DefaultApi itemsCountPost POST /items/count/
DefaultApi itemsPost POST /items/
DefaultApi ordersPost POST /orders/
DefaultApi ordersServicesPost POST /orders/services/
DefaultApi queryPost POST /query/
DefaultApi servicesDelete DELETE /services/
DefaultApi servicesGet GET /services/
DefaultApi servicesOpenGet GET /services/open/
DefaultApi servicesPost POST /services/
DefaultApi servicesPut PUT /services/
DefaultApi variationDelete DELETE /variation/
DefaultApi variationGet GET /variation/
DefaultApi variationPost POST /variation/
DefaultApi variationPut PUT /variation/
DefaultApi writeDelete DELETE /write/
DefaultApi writePost POST /write/

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

APIKey

  • Type: API key
  • API key parameter name: APIKey
  • Location: HTTP header

AccountID

  • Type: API key
  • API key parameter name: accountid
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issue.

Author