Skip to content

Latest commit

 

History

History
881 lines (702 loc) · 28.2 KB

EcommerceApi.md

File metadata and controls

881 lines (702 loc) · 28.2 KB

EcommerceApi

All URIs are relative to https://api.egoiapp.com

Method HTTP request Description
createCart POST /{domain}/carts Create cart
createCatalog POST /catalogs Create new catalog
createOrder POST /{domain}/orders Create order
createProduct POST /catalogs/{catalog_id}/products Create new product
deleteCatalog DELETE /catalogs/{catalog_id} Remove catalog
deleteProduct DELETE /catalogs/{catalog_id}/products/{product_identifier} Remove product
getAllCatalogs GET /catalogs Get all catalogs
getAllProducts GET /catalogs/{catalog_id}/products Get all products
getProduct GET /catalogs/{catalog_id}/products/{product_identifier} Get product
importProducts POST /catalogs/{catalog_id}/products/actions/import Import products
updateProduct PATCH /catalogs/{catalog_id}/products/{product_identifier} Update product

createCart

AcceptedResponse createCart(domain, cart)

Create cart

Creates a new cart. If contact_id is specified, order will be atached to the contact, if the contact propreties are specified, we'll create the user, if its already in your list it will get the correct contact (make sure you are sending atleast all configured list's unique fields). This same logic is also applied to the product_identifier.

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    String domain = "domain_example"; // String | Domain
    Cart cart = new Cart(); // Cart | Parameters for the Carts
    try {
      AcceptedResponse result = apiInstance.createCart(domain, cart);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#createCart");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
domain String Domain
cart Cart Parameters for the Carts

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 NotFound -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

createCatalog

Catalog createCatalog(catalogPostRequest)

Create new catalog

Creates a new catalog

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    CatalogPostRequest catalogPostRequest = new CatalogPostRequest(); // CatalogPostRequest | Parameters for the Catalog
    try {
      Catalog result = apiInstance.createCatalog(catalogPostRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#createCatalog");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogPostRequest CatalogPostRequest Parameters for the Catalog

Return type

Catalog

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
408 Request Timeout -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

createOrder

AcceptedResponse createOrder(domain, createOrder)

Create order

Creates a new order. If contact_id is specified, order will be atached to the contact, if the contact propreties are specified, we'll create the user, if its already in your list it will get the correct contact (make sure you are sending atleast all configured list's unique fields). This same logic is also applied to the product_identifier.

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    String domain = "domain_example"; // String | Domain
    CreateOrder createOrder = new CreateOrder(); // CreateOrder | Parameters for the Orders
    try {
      AcceptedResponse result = apiInstance.createOrder(domain, createOrder);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#createOrder");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
domain String Domain
createOrder CreateOrder Parameters for the Orders

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 NotFound -
408 Request Timeout -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

createProduct

Product createProduct(catalogId, productPostRequest)

Create new product

Creates a new product

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    Integer catalogId = 56; // Integer | ID of the Catalog
    ProductPostRequest productPostRequest = new ProductPostRequest(); // ProductPostRequest | Parameters for the Product
    try {
      Product result = apiInstance.createProduct(catalogId, productPostRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#createProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogId Integer ID of the Catalog
productPostRequest ProductPostRequest Parameters for the Product

Return type

Product

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 NotFound -
408 Request Timeout -
409 Conflict -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

deleteCatalog

deleteCatalog(catalogId)

Remove catalog

Remove catalog information given its ID

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    Integer catalogId = 56; // Integer | ID of the Catalog
    try {
      apiInstance.deleteCatalog(catalogId);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#deleteCatalog");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogId Integer ID of the Catalog

Return type

null (empty response body)

Authorization

Apikey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 No Content -
401 Unauthorized -
403 Forbidden -
404 Not Found -
408 Request Timeout -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

deleteProduct

deleteProduct(catalogId, productIdentifier)

Remove product

Remove product information given its ID

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    Integer catalogId = 56; // Integer | ID of the Catalog
    String productIdentifier = "productIdentifier_example"; // String | ID of the Product
    try {
      apiInstance.deleteProduct(catalogId, productIdentifier);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#deleteProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogId Integer ID of the Catalog
productIdentifier String ID of the Product

Return type

null (empty response body)

Authorization

Apikey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 No Content -
401 Unauthorized -
403 Forbidden -
404 Not Found -
408 Request Timeout -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

getAllCatalogs

CatalogCollection getAllCatalogs()

Get all catalogs

Returns all catalogs

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    try {
      CatalogCollection result = apiInstance.getAllCatalogs();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#getAllCatalogs");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

CatalogCollection

Authorization

Apikey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
401 Unauthorized -
403 Forbidden -
408 Request Timeout -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

getAllProducts

ProductCollection getAllProducts(catalogId, productIdentifier, offset, limit)

Get all products

Returns all products for the given catalog

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    Integer catalogId = 56; // Integer | ID of the Catalog
    String productIdentifier = "productIdentifier_example"; // String | Product ID in your store
    Integer offset = 56; // Integer | Element offset (starting at zero for the first element)
    Integer limit = 10; // Integer | Number of items to return
    try {
      ProductCollection result = apiInstance.getAllProducts(catalogId, productIdentifier, offset, limit);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#getAllProducts");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogId Integer ID of the Catalog
productIdentifier String Product ID in your store [optional]
offset Integer Element offset (starting at zero for the first element) [optional]
limit Integer Number of items to return [optional] [default to 10]

Return type

ProductCollection

Authorization

Apikey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
401 Unauthorized -
403 Forbidden -
404 NotFound -
408 Request Timeout -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

getProduct

Product getProduct(catalogId, productIdentifier)

Get product

Returns product information given its ID

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    Integer catalogId = 56; // Integer | ID of the Catalog
    String productIdentifier = "productIdentifier_example"; // String | ID of the Product
    try {
      Product result = apiInstance.getProduct(catalogId, productIdentifier);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#getProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogId Integer ID of the Catalog
productIdentifier String ID of the Product

Return type

Product

Authorization

Apikey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
401 Unauthorized -
403 Forbidden -
404 Not Found -
408 Request Timeout -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

importProducts

AcceptedResponse importProducts(catalogId, productBulkRequest)

Import products

Imports a collection of products</br> DISCLAIMER: stream limits applied. [view here](#section/Stream-Limits 'Stream Limits')

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    Integer catalogId = 56; // Integer | ID of the Catalog
    ProductBulkRequest productBulkRequest = new ProductBulkRequest(); // ProductBulkRequest | Parameters for the Product
    try {
      AcceptedResponse result = apiInstance.importProducts(catalogId, productBulkRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#importProducts");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogId Integer ID of the Catalog
productBulkRequest ProductBulkRequest Parameters for the Product

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
202 Accepted -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 NotFound -
408 Request Timeout -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -

updateProduct

Product updateProduct(catalogId, productIdentifier, productPatchRequest)

Update product

Updates a product

Example

// Import classes:
import org.egoi.client.ApiClient;
import org.egoi.client.ApiException;
import org.egoi.client.Configuration;
import org.egoi.client.auth.*;
import org.egoi.client.models.*;
import org.egoi.client.api.EcommerceApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.egoiapp.com");
    
    // 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");

    EcommerceApi apiInstance = new EcommerceApi(defaultClient);
    Integer catalogId = 56; // Integer | ID of the Catalog
    String productIdentifier = "productIdentifier_example"; // String | ID of the Product
    ProductPatchRequest productPatchRequest = new ProductPatchRequest(); // ProductPatchRequest | Parameters for the product
    try {
      Product result = apiInstance.updateProduct(catalogId, productIdentifier, productPatchRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EcommerceApi#updateProduct");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
catalogId Integer ID of the Catalog
productIdentifier String ID of the Product
productPatchRequest ProductPatchRequest Parameters for the product

Return type

Product

Authorization

Apikey

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 OK -
400 Bad Request -
401 Unauthorized -
403 Forbidden -
404 Not Found -
408 Request Timeout -
422 Unprocessable Entity -
429 Too Many Requests -
500 Internal Server Error -
503 Service Unavailable -