aliseeks_api 1.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +79 -0
- data/README.md +171 -0
- data/Rakefile +10 -0
- data/aliseeks_api.gemspec +45 -0
- data/docs/Amount.md +9 -0
- data/docs/BestSellingSearchItem.md +15 -0
- data/docs/BestSellingSearchRequest.md +12 -0
- data/docs/BestSellingSearchResponse.md +8 -0
- data/docs/DoubleRange.md +9 -0
- data/docs/ImageSearchCategory.md +9 -0
- data/docs/ImageSearchItem.md +12 -0
- data/docs/ImageSearchRequest.md +12 -0
- data/docs/ImageSearchResponse.md +10 -0
- data/docs/IntegerRange.md +9 -0
- data/docs/NonRealtimeCurrency.md +7 -0
- data/docs/PriceRange.md +9 -0
- data/docs/PriceSummary.md +13 -0
- data/docs/Product.md +28 -0
- data/docs/ProductAttribute.md +11 -0
- data/docs/ProductBulkOption.md +10 -0
- data/docs/ProductDetail.md +24 -0
- data/docs/ProductDetailsRequest.md +12 -0
- data/docs/ProductHtmlDescription.md +8 -0
- data/docs/ProductHtmlDescriptionRequest.md +8 -0
- data/docs/ProductPriceOption.md +14 -0
- data/docs/ProductPromotion.md +9 -0
- data/docs/ProductPropertyVariationIdentifier.md +10 -0
- data/docs/ProductRequest.md +15 -0
- data/docs/ProductRequestComponent.md +7 -0
- data/docs/ProductReview.md +18 -0
- data/docs/ProductReviews.md +17 -0
- data/docs/ProductReviewsRequest.md +10 -0
- data/docs/ProductSeller.md +12 -0
- data/docs/ProductShipping.md +8 -0
- data/docs/ProductShippingOptions.md +15 -0
- data/docs/ProductShippingRequest.md +12 -0
- data/docs/ProductSku.md +16 -0
- data/docs/ProductSkus.md +8 -0
- data/docs/ProductSkusRequest.md +11 -0
- data/docs/ProductsApi.md +316 -0
- data/docs/PromotionOption.md +12 -0
- data/docs/RealtimeCurrency.md +7 -0
- data/docs/RealtimeSearchAggregation.md +9 -0
- data/docs/RealtimeSearchItem.md +14 -0
- data/docs/RealtimeSearchRequest.md +14 -0
- data/docs/RealtimeSearchResponse.md +9 -0
- data/docs/SearchAggregation.md +11 -0
- data/docs/SearchApi.md +263 -0
- data/docs/SearchItem.md +20 -0
- data/docs/SearchItemFreight.md +9 -0
- data/docs/SearchItemFreightType.md +8 -0
- data/docs/SearchItemSeller.md +13 -0
- data/docs/SearchPriceOption.md +10 -0
- data/docs/SearchRequest.md +24 -0
- data/docs/SearchResponse.md +9 -0
- data/docs/SkuPriceOption.md +16 -0
- data/docs/SkuPriceOptionProperty.md +13 -0
- data/docs/SkuProperty.md +10 -0
- data/docs/SkuPropertyValue.md +10 -0
- data/docs/StringRange.md +9 -0
- data/docs/TimeDuration.md +11 -0
- data/docs/TradeInformation.md +9 -0
- data/docs/UploadImageByUrlRequest.md +8 -0
- data/docs/UploadImageResponse.md +8 -0
- data/docs/WebError.md +11 -0
- data/git_push.sh +55 -0
- data/lib/aliseeks_api.rb +100 -0
- data/lib/aliseeks_api/api/products_api.rb +337 -0
- data/lib/aliseeks_api/api/search_api.rb +288 -0
- data/lib/aliseeks_api/api_client.rb +389 -0
- data/lib/aliseeks_api/api_error.rb +38 -0
- data/lib/aliseeks_api/configuration.rb +251 -0
- data/lib/aliseeks_api/models/amount.rb +195 -0
- data/lib/aliseeks_api/models/best_selling_search_item.rb +257 -0
- data/lib/aliseeks_api/models/best_selling_search_request.rb +278 -0
- data/lib/aliseeks_api/models/best_selling_search_response.rb +187 -0
- data/lib/aliseeks_api/models/double_range.rb +193 -0
- data/lib/aliseeks_api/models/image_search_category.rb +195 -0
- data/lib/aliseeks_api/models/image_search_item.rb +224 -0
- data/lib/aliseeks_api/models/image_search_request.rb +240 -0
- data/lib/aliseeks_api/models/image_search_response.rb +209 -0
- data/lib/aliseeks_api/models/integer_range.rb +193 -0
- data/lib/aliseeks_api/models/non_realtime_currency.rb +48 -0
- data/lib/aliseeks_api/models/price_range.rb +193 -0
- data/lib/aliseeks_api/models/price_summary.rb +229 -0
- data/lib/aliseeks_api/models/product.rb +422 -0
- data/lib/aliseeks_api/models/product_attribute.rb +215 -0
- data/lib/aliseeks_api/models/product_bulk_option.rb +204 -0
- data/lib/aliseeks_api/models/product_detail.rb +353 -0
- data/lib/aliseeks_api/models/product_details_request.rb +230 -0
- data/lib/aliseeks_api/models/product_html_description.rb +185 -0
- data/lib/aliseeks_api/models/product_html_description_request.rb +185 -0
- data/lib/aliseeks_api/models/product_price_option.rb +240 -0
- data/lib/aliseeks_api/models/product_promotion.rb +194 -0
- data/lib/aliseeks_api/models/product_property_variation_identifier.rb +205 -0
- data/lib/aliseeks_api/models/product_request.rb +288 -0
- data/lib/aliseeks_api/models/product_request_component.rb +31 -0
- data/lib/aliseeks_api/models/product_review.rb +287 -0
- data/lib/aliseeks_api/models/product_reviews.rb +270 -0
- data/lib/aliseeks_api/models/product_reviews_request.rb +235 -0
- data/lib/aliseeks_api/models/product_seller.rb +225 -0
- data/lib/aliseeks_api/models/product_shipping.rb +187 -0
- data/lib/aliseeks_api/models/product_shipping_options.rb +253 -0
- data/lib/aliseeks_api/models/product_shipping_request.rb +256 -0
- data/lib/aliseeks_api/models/product_sku.rb +266 -0
- data/lib/aliseeks_api/models/product_skus.rb +187 -0
- data/lib/aliseeks_api/models/product_skus_request.rb +218 -0
- data/lib/aliseeks_api/models/promotion_option.rb +222 -0
- data/lib/aliseeks_api/models/realtime_currency.rb +45 -0
- data/lib/aliseeks_api/models/realtime_search_aggregation.rb +197 -0
- data/lib/aliseeks_api/models/realtime_search_item.rb +246 -0
- data/lib/aliseeks_api/models/realtime_search_request.rb +304 -0
- data/lib/aliseeks_api/models/realtime_search_response.rb +196 -0
- data/lib/aliseeks_api/models/search_aggregation.rb +215 -0
- data/lib/aliseeks_api/models/search_item.rb +304 -0
- data/lib/aliseeks_api/models/search_item_freight.rb +194 -0
- data/lib/aliseeks_api/models/search_item_freight_type.rb +185 -0
- data/lib/aliseeks_api/models/search_item_seller.rb +235 -0
- data/lib/aliseeks_api/models/search_price_option.rb +203 -0
- data/lib/aliseeks_api/models/search_request.rb +441 -0
- data/lib/aliseeks_api/models/search_response.rb +196 -0
- data/lib/aliseeks_api/models/sku_price_option.rb +264 -0
- data/lib/aliseeks_api/models/sku_price_option_property.rb +235 -0
- data/lib/aliseeks_api/models/sku_property.rb +207 -0
- data/lib/aliseeks_api/models/sku_property_value.rb +205 -0
- data/lib/aliseeks_api/models/string_range.rb +193 -0
- data/lib/aliseeks_api/models/time_duration.rb +211 -0
- data/lib/aliseeks_api/models/trade_information.rb +195 -0
- data/lib/aliseeks_api/models/upload_image_by_url_request.rb +185 -0
- data/lib/aliseeks_api/models/upload_image_response.rb +185 -0
- data/lib/aliseeks_api/models/web_error.rb +211 -0
- data/lib/aliseeks_api/version.rb +15 -0
- data/spec/api/products_api_spec.rb +101 -0
- data/spec/api/search_api_spec.rb +90 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/amount_spec.rb +47 -0
- data/spec/models/best_selling_search_item_spec.rb +83 -0
- data/spec/models/best_selling_search_request_spec.rb +73 -0
- data/spec/models/best_selling_search_response_spec.rb +41 -0
- data/spec/models/double_range_spec.rb +47 -0
- data/spec/models/image_search_category_spec.rb +47 -0
- data/spec/models/image_search_item_spec.rb +65 -0
- data/spec/models/image_search_request_spec.rb +65 -0
- data/spec/models/image_search_response_spec.rb +53 -0
- data/spec/models/integer_range_spec.rb +47 -0
- data/spec/models/non_realtime_currency_spec.rb +35 -0
- data/spec/models/price_range_spec.rb +47 -0
- data/spec/models/price_summary_spec.rb +71 -0
- data/spec/models/product_attribute_spec.rb +59 -0
- data/spec/models/product_bulk_option_spec.rb +53 -0
- data/spec/models/product_detail_spec.rb +137 -0
- data/spec/models/product_details_request_spec.rb +65 -0
- data/spec/models/product_html_description_request_spec.rb +41 -0
- data/spec/models/product_html_description_spec.rb +41 -0
- data/spec/models/product_price_option_spec.rb +77 -0
- data/spec/models/product_promotion_spec.rb +47 -0
- data/spec/models/product_property_variation_identifier_spec.rb +53 -0
- data/spec/models/product_request_component_spec.rb +35 -0
- data/spec/models/product_request_spec.rb +83 -0
- data/spec/models/product_review_spec.rb +101 -0
- data/spec/models/product_reviews_request_spec.rb +53 -0
- data/spec/models/product_reviews_spec.rb +95 -0
- data/spec/models/product_seller_spec.rb +65 -0
- data/spec/models/product_shipping_options_spec.rb +83 -0
- data/spec/models/product_shipping_request_spec.rb +65 -0
- data/spec/models/product_shipping_spec.rb +41 -0
- data/spec/models/product_sku_spec.rb +89 -0
- data/spec/models/product_skus_request_spec.rb +59 -0
- data/spec/models/product_skus_spec.rb +41 -0
- data/spec/models/product_spec.rb +165 -0
- data/spec/models/promotion_option_spec.rb +65 -0
- data/spec/models/realtime_currency_spec.rb +35 -0
- data/spec/models/realtime_search_aggregation_spec.rb +47 -0
- data/spec/models/realtime_search_item_spec.rb +77 -0
- data/spec/models/realtime_search_request_spec.rb +81 -0
- data/spec/models/realtime_search_response_spec.rb +47 -0
- data/spec/models/search_aggregation_spec.rb +59 -0
- data/spec/models/search_item_freight_spec.rb +47 -0
- data/spec/models/search_item_freight_type_spec.rb +41 -0
- data/spec/models/search_item_seller_spec.rb +71 -0
- data/spec/models/search_item_spec.rb +113 -0
- data/spec/models/search_price_option_spec.rb +53 -0
- data/spec/models/search_request_spec.rb +145 -0
- data/spec/models/search_response_spec.rb +47 -0
- data/spec/models/sku_price_option_property_spec.rb +71 -0
- data/spec/models/sku_price_option_spec.rb +89 -0
- data/spec/models/sku_property_spec.rb +53 -0
- data/spec/models/sku_property_value_spec.rb +53 -0
- data/spec/models/string_range_spec.rb +47 -0
- data/spec/models/time_duration_spec.rb +59 -0
- data/spec/models/trade_information_spec.rb +47 -0
- data/spec/models/upload_image_by_url_request_spec.rb +41 -0
- data/spec/models/upload_image_response_spec.rb +41 -0
- data/spec/models/web_error_spec.rb +59 -0
- data/spec/spec_helper.rb +111 -0
- metadata +485 -0
data/docs/PriceRange.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# AliseeksApi::PriceSummary
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**original_amount** | [**PriceRange**](PriceRange.md) | | [optional]
|
|
7
|
+
**unit_original_amount** | [**PriceRange**](PriceRange.md) | | [optional]
|
|
8
|
+
**discounted_amount** | [**PriceRange**](PriceRange.md) | | [optional]
|
|
9
|
+
**unit_discounted_amount** | [**PriceRange**](PriceRange.md) | | [optional]
|
|
10
|
+
**bulk_amount** | [**PriceRange**](PriceRange.md) | | [optional]
|
|
11
|
+
**unit_bulk_amount** | [**PriceRange**](PriceRange.md) | | [optional]
|
|
12
|
+
|
|
13
|
+
|
data/docs/Product.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# AliseeksApi::Product
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | The AliExpress item ID | [optional]
|
|
7
|
+
**category_id** | **String** | The item category | [optional]
|
|
8
|
+
**company_id** | **String** | The company ID | [optional]
|
|
9
|
+
**seller_id** | **String** | The seller ID | [optional]
|
|
10
|
+
**title** | **String** | The subject / title of the item | [optional]
|
|
11
|
+
**status_id** | **Integer** | The AliExpress status ID | [optional]
|
|
12
|
+
**status** | **String** | The AliExpress status | [optional]
|
|
13
|
+
**count_per_lot** | **Integer** | The number of items per lot | [optional]
|
|
14
|
+
**wish_list_count** | **Integer** | Number of times the item has been added to a wishlist | [optional]
|
|
15
|
+
**unit** | **String** | The unit of the item | [optional]
|
|
16
|
+
**multi_unit** | **String** | The unit for multiple items | [optional]
|
|
17
|
+
**seller** | [**ProductSeller**](ProductSeller.md) | | [optional]
|
|
18
|
+
**reviews** | [**ProductReviews**](ProductReviews.md) | | [optional]
|
|
19
|
+
**trade** | [**TradeInformation**](TradeInformation.md) | | [optional]
|
|
20
|
+
**promotion** | [**ProductPromotion**](ProductPromotion.md) | | [optional]
|
|
21
|
+
**product_images** | **Array<String>** | The item images | [optional]
|
|
22
|
+
**attributes** | [**Array<ProductAttribute>**](ProductAttribute.md) | Attributes associated with the AliExpress product | [optional]
|
|
23
|
+
**html_description** | **String** | The product HTML description | [optional]
|
|
24
|
+
**price_summary** | [**PriceSummary**](PriceSummary.md) | | [optional]
|
|
25
|
+
**prices** | [**Array<SkuPriceOption>**](SkuPriceOption.md) | All the variations of an AliExpress item and prices associated with each variation | [optional]
|
|
26
|
+
**shipping** | [**Array<ProductShippingOptions>**](ProductShippingOptions.md) | The shipping options of an AliExpress item | [optional]
|
|
27
|
+
|
|
28
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# AliseeksApi::ProductAttribute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | The name of the attribute | [optional]
|
|
7
|
+
**id** | **Integer** | The ID of the attribute | [optional]
|
|
8
|
+
**value** | **String** | The value of the attribute | [optional]
|
|
9
|
+
**value_id** | **String** | The ID of the value of the attribute | [optional]
|
|
10
|
+
|
|
11
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# AliseeksApi::ProductBulkOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**price** | [**Amount**](Amount.md) | | [optional]
|
|
7
|
+
**discount** | **Float** | The discount for the bulk option | [optional]
|
|
8
|
+
**bulk_order_count** | **Integer** | The amount to order to be considered a bulk purchase | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AliseeksApi::ProductDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**id** | **String** | The AliExpress item ID | [optional]
|
|
7
|
+
**category_id** | **String** | The item category | [optional]
|
|
8
|
+
**company_id** | **String** | The company ID | [optional]
|
|
9
|
+
**seller_id** | **String** | The seller ID | [optional]
|
|
10
|
+
**title** | **String** | The subject / title of the item | [optional]
|
|
11
|
+
**product_images** | **Array<String>** | The item images | [optional]
|
|
12
|
+
**status_id** | **Integer** | The AliExpress status | [optional]
|
|
13
|
+
**count_per_lot** | **Integer** | The number of items per lot | [optional]
|
|
14
|
+
**wish_list_count** | **Integer** | Number of times the item has been added to a wishlist | [optional]
|
|
15
|
+
**unit** | **String** | The unit of the item | [optional]
|
|
16
|
+
**multi_unit** | **String** | The unit for multiple items | [optional]
|
|
17
|
+
**promotions** | [**Array<PromotionOption>**](PromotionOption.md) | The promotions present on an item | [optional]
|
|
18
|
+
**attributes** | [**Array<ProductAttribute>**](ProductAttribute.md) | The attributes of an item | [optional]
|
|
19
|
+
**prices** | [**Array<ProductPriceOption>**](ProductPriceOption.md) | List of price options for an item | [optional]
|
|
20
|
+
**reviews** | [**ProductReviews**](ProductReviews.md) | | [optional]
|
|
21
|
+
**trade** | [**TradeInformation**](TradeInformation.md) | | [optional]
|
|
22
|
+
**sku_properties** | [**Array<SkuProperty>**](SkuProperty.md) | List of sku properties that correspond to an item | [optional]
|
|
23
|
+
|
|
24
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# AliseeksApi::ProductDetailsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**currency** | [**RealtimeCurrency**](RealtimeCurrency.md) | | [optional]
|
|
7
|
+
**product_id** | **String** | The Product ID | [optional]
|
|
8
|
+
**locale** | **String** | AliExpress locale to use. | [optional] [default to 'en_US']
|
|
9
|
+
**time_zone** | **String** | Timezone to format times in | [optional] [default to 'CST']
|
|
10
|
+
**need_store_info** | **BOOLEAN** | Whether we should fetch store information | [optional] [default to false]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# AliseeksApi::ProductPriceOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**max_amount** | [**Amount**](Amount.md) | | [optional]
|
|
7
|
+
**max_amount_per_piece** | [**Amount**](Amount.md) | | [optional]
|
|
8
|
+
**min_amount** | [**Amount**](Amount.md) | | [optional]
|
|
9
|
+
**min_amount_per_piece** | [**Amount**](Amount.md) | | [optional]
|
|
10
|
+
**minimum_purchase** | **Integer** | The minimum purchase amount for this price option | [optional]
|
|
11
|
+
**processing_time** | **Float** | The amount of time to process an order in this option | [optional]
|
|
12
|
+
**bulk_option** | [**ProductBulkOption**](ProductBulkOption.md) | | [optional]
|
|
13
|
+
|
|
14
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# AliseeksApi::ProductPromotion
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**discount** | **Float** | The discount of a promotion | [optional]
|
|
7
|
+
**time_left** | [**TimeDuration**](TimeDuration.md) | | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# AliseeksApi::ProductPropertyVariationIdentifier
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**property_id** | **Integer** | The ID of the property | [optional]
|
|
7
|
+
**property_value_id** | **Integer** | The ID of the property value ID | [optional]
|
|
8
|
+
**property_value_name** | **String** | The name of the property | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# AliseeksApi::ProductRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**currency** | [**RealtimeCurrency**](RealtimeCurrency.md) | | [optional]
|
|
7
|
+
**product_id** | **String** | The Product ID | [optional]
|
|
8
|
+
**locale** | **String** | AliExpress locale to use. | [optional] [default to 'en_US']
|
|
9
|
+
**time_zone** | **String** | Timezone to format times in | [optional] [default to 'CST']
|
|
10
|
+
**country** | **String** | Two character iso country code | [optional]
|
|
11
|
+
**send_goods_country** | **String** | Two character iso country code | [optional]
|
|
12
|
+
**quantity** | **Integer** | | [optional]
|
|
13
|
+
**components** | [**Array<ProductRequestComponent>**](ProductRequestComponent.md) | | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# AliseeksApi::ProductReview
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**buyer_name** | **String** | The name of the buyer of the product | [optional]
|
|
7
|
+
**buyer_country** | **String** | The country of the buyer of the product | [optional]
|
|
8
|
+
**buyer_rating** | **Float** | The rating provided by the buyer | [optional]
|
|
9
|
+
**review_date** | **String** | The date of the review | [optional]
|
|
10
|
+
**review** | **String** | The actual review message | [optional]
|
|
11
|
+
**translated_review** | **String** | The translated review message | [optional]
|
|
12
|
+
**images** | **Array<String>** | Images that have been posted with the review | [optional]
|
|
13
|
+
**shipping** | **String** | The shipping chosen by the reviewer | [optional]
|
|
14
|
+
**sku_information** | **String** | The sku information of the product purchased | [optional]
|
|
15
|
+
**down_votes** | **Float** | The number of downvotes on this review | [optional]
|
|
16
|
+
**up_votes** | **Float** | The number of upvotes on this review | [optional]
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AliseeksApi::ProductReviews
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**five_star_count** | **Integer** | | [optional]
|
|
7
|
+
**four_star_count** | **Integer** | | [optional]
|
|
8
|
+
**three_star_count** | **Integer** | | [optional]
|
|
9
|
+
**two_star_count** | **Integer** | | [optional]
|
|
10
|
+
**one_star_count** | **Integer** | | [optional]
|
|
11
|
+
**total_count** | **Integer** | Total review count | [optional]
|
|
12
|
+
**positive_count** | **Integer** | Count of positive reviews | [optional]
|
|
13
|
+
**negative_count** | **Integer** | Count of negative reviews | [optional]
|
|
14
|
+
**neutral_count** | **Integer** | Count of neutral reviews | [optional]
|
|
15
|
+
**ratings** | **Float** | Product ratings score | [optional]
|
|
16
|
+
|
|
17
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# AliseeksApi::ProductReviewsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**product_id** | **String** | The AliExpress product ID | [optional]
|
|
7
|
+
**page** | **Float** | The page number of product reviews to retrieve | [optional]
|
|
8
|
+
**country** | **String** | Two character iso country code | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# AliseeksApi::ProductSeller
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**store_id** | **Integer** | The ID of the seller store | [optional]
|
|
7
|
+
**store_url** | **String** | The URL of the seller store | [optional]
|
|
8
|
+
**store_name** | **String** | The name of the seller store | [optional]
|
|
9
|
+
**seller_level** | **String** | The level of the seller | [optional]
|
|
10
|
+
**positive_feedback_rate** | **Float** | The positive feedback rate of the seller | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# AliseeksApi::ProductShipping
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**options** | [**Array<ProductShippingOptions>**](ProductShippingOptions.md) | The list of product shipping options | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# AliseeksApi::ProductShippingOptions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**company** | **String** | The shipping company | [optional]
|
|
7
|
+
**service_name** | **String** | The name of the shipping service | [optional]
|
|
8
|
+
**tracking** | **BOOLEAN** | Whether or no the shipping option has tracking | [optional]
|
|
9
|
+
**amount** | [**Amount**](Amount.md) | | [optional]
|
|
10
|
+
**discount** | **Float** | The discount currently on this shipping option | [optional]
|
|
11
|
+
**commit_days** | **Integer** | The number of days that are commited for this shipping option | [optional]
|
|
12
|
+
**ship_from** | **String** | The place where the shipping comes from | [optional]
|
|
13
|
+
**delivery_time** | [**IntegerRange**](IntegerRange.md) | | [optional]
|
|
14
|
+
|
|
15
|
+
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# AliseeksApi::ProductShippingRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**product_id** | **String** | The Product ID | [optional]
|
|
7
|
+
**country** | **String** | Two character iso country code | [optional]
|
|
8
|
+
**send_goods_country** | **String** | Two character iso country code | [optional]
|
|
9
|
+
**quantity** | **Integer** | Quantity that will be purchased | [optional] [default to 1]
|
|
10
|
+
**currency** | [**RealtimeCurrency**](RealtimeCurrency.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/ProductSku.md
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# AliseeksApi::ProductSku
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**property_identifiers** | [**Array<ProductPropertyVariationIdentifier>**](ProductPropertyVariationIdentifier.md) | List of property variation identifiers | [optional]
|
|
7
|
+
**property_value_ids** | **Array<Integer>** | List of property value IDs | [optional]
|
|
8
|
+
**product_id** | **String** | The ID of the product | [optional]
|
|
9
|
+
**price** | [**Amount**](Amount.md) | | [optional]
|
|
10
|
+
**discounted_price** | [**Amount**](Amount.md) | | [optional]
|
|
11
|
+
**bulk_price** | [**Amount**](Amount.md) | | [optional]
|
|
12
|
+
**bulk_quantity** | **Integer** | The quantity required to use the bulk quantity price | [optional]
|
|
13
|
+
**stock** | **Integer** | The stock of the product variation | [optional]
|
|
14
|
+
**image_url** | **String** | The image URL of the product variation | [optional]
|
|
15
|
+
|
|
16
|
+
|
data/docs/ProductSkus.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# AliseeksApi::ProductSkusRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**product_id** | **String** | The Product ID | [optional]
|
|
7
|
+
**currency** | [**RealtimeCurrency**](RealtimeCurrency.md) | | [optional]
|
|
8
|
+
**language** | **String** | AliExpress language to retrieve content in. Use locale. | [optional] [default to 'en_US']
|
|
9
|
+
**locale** | **String** | AliExpress locale to use. | [optional] [default to 'en_US']
|
|
10
|
+
|
|
11
|
+
|
data/docs/ProductsApi.md
ADDED
|
@@ -0,0 +1,316 @@
|
|
|
1
|
+
# AliseeksApi::ProductsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.aliseeks.com/v1*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**get_product**](ProductsApi.md#get_product) | **POST** /products | Get products details as an aggregated request from AliExpress in realtime.
|
|
8
|
+
[**get_product_details**](ProductsApi.md#get_product_details) | **POST** /products/details | Gets product details from AliExpress in realtime.
|
|
9
|
+
[**get_product_html_description**](ProductsApi.md#get_product_html_description) | **POST** /products/description/html | Get product HTML description from AliExpress in realtime.
|
|
10
|
+
[**get_product_reviews**](ProductsApi.md#get_product_reviews) | **POST** /products/reviews | Get product reviews from AliExpress in realtime
|
|
11
|
+
[**get_product_shipping**](ProductsApi.md#get_product_shipping) | **POST** /products/shipping | Gets product shipping information AliExpress in realtime.
|
|
12
|
+
[**get_product_skus**](ProductsApi.md#get_product_skus) | **POST** /products/variations | Gets product skus / variation information from AliExpress in realtime.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
# **get_product**
|
|
16
|
+
> Product get_product(opts)
|
|
17
|
+
|
|
18
|
+
Get products details as an aggregated request from AliExpress in realtime.
|
|
19
|
+
|
|
20
|
+
### Example
|
|
21
|
+
```ruby
|
|
22
|
+
# load the gem
|
|
23
|
+
require 'aliseeks_api'
|
|
24
|
+
# setup authorization
|
|
25
|
+
AliseeksApi.configure do |config|
|
|
26
|
+
# Configure API key authorization: ApiKeyAuth
|
|
27
|
+
config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
|
|
28
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
29
|
+
#config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = AliseeksApi::ProductsApi.new
|
|
33
|
+
opts = {
|
|
34
|
+
product_request: AliseeksApi::ProductRequest.new # ProductRequest | The request body of get product
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
#Get products details as an aggregated request from AliExpress in realtime.
|
|
39
|
+
result = api_instance.get_product(opts)
|
|
40
|
+
p result
|
|
41
|
+
rescue AliseeksApi::ApiError => e
|
|
42
|
+
puts "Exception when calling ProductsApi->get_product: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
### Parameters
|
|
47
|
+
|
|
48
|
+
Name | Type | Description | Notes
|
|
49
|
+
------------- | ------------- | ------------- | -------------
|
|
50
|
+
**product_request** | [**ProductRequest**](ProductRequest.md)| The request body of get product | [optional]
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**Product**](Product.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: application/json
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
# **get_product_details**
|
|
68
|
+
> ProductDetail get_product_details(product_details_request)
|
|
69
|
+
|
|
70
|
+
Gets product details from AliExpress in realtime.
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
```ruby
|
|
74
|
+
# load the gem
|
|
75
|
+
require 'aliseeks_api'
|
|
76
|
+
# setup authorization
|
|
77
|
+
AliseeksApi.configure do |config|
|
|
78
|
+
# Configure API key authorization: ApiKeyAuth
|
|
79
|
+
config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
|
|
80
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
81
|
+
#config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
api_instance = AliseeksApi::ProductsApi.new
|
|
85
|
+
product_details_request = AliseeksApi::ProductDetailsRequest.new # ProductDetailsRequest | The request body to get product details
|
|
86
|
+
|
|
87
|
+
begin
|
|
88
|
+
#Gets product details from AliExpress in realtime.
|
|
89
|
+
result = api_instance.get_product_details(product_details_request)
|
|
90
|
+
p result
|
|
91
|
+
rescue AliseeksApi::ApiError => e
|
|
92
|
+
puts "Exception when calling ProductsApi->get_product_details: #{e}"
|
|
93
|
+
end
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
Name | Type | Description | Notes
|
|
99
|
+
------------- | ------------- | ------------- | -------------
|
|
100
|
+
**product_details_request** | [**ProductDetailsRequest**](ProductDetailsRequest.md)| The request body to get product details |
|
|
101
|
+
|
|
102
|
+
### Return type
|
|
103
|
+
|
|
104
|
+
[**ProductDetail**](ProductDetail.md)
|
|
105
|
+
|
|
106
|
+
### Authorization
|
|
107
|
+
|
|
108
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
109
|
+
|
|
110
|
+
### HTTP request headers
|
|
111
|
+
|
|
112
|
+
- **Content-Type**: application/json
|
|
113
|
+
- **Accept**: application/json
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
# **get_product_html_description**
|
|
118
|
+
> ProductHtmlDescription get_product_html_description(product_html_description_request)
|
|
119
|
+
|
|
120
|
+
Get product HTML description from AliExpress in realtime.
|
|
121
|
+
|
|
122
|
+
### Example
|
|
123
|
+
```ruby
|
|
124
|
+
# load the gem
|
|
125
|
+
require 'aliseeks_api'
|
|
126
|
+
# setup authorization
|
|
127
|
+
AliseeksApi.configure do |config|
|
|
128
|
+
# Configure API key authorization: ApiKeyAuth
|
|
129
|
+
config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
|
|
130
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
131
|
+
#config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
|
|
132
|
+
end
|
|
133
|
+
|
|
134
|
+
api_instance = AliseeksApi::ProductsApi.new
|
|
135
|
+
product_html_description_request = AliseeksApi::ProductHtmlDescriptionRequest.new # ProductHtmlDescriptionRequest | The request body to get product html description
|
|
136
|
+
|
|
137
|
+
begin
|
|
138
|
+
#Get product HTML description from AliExpress in realtime.
|
|
139
|
+
result = api_instance.get_product_html_description(product_html_description_request)
|
|
140
|
+
p result
|
|
141
|
+
rescue AliseeksApi::ApiError => e
|
|
142
|
+
puts "Exception when calling ProductsApi->get_product_html_description: #{e}"
|
|
143
|
+
end
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### Parameters
|
|
147
|
+
|
|
148
|
+
Name | Type | Description | Notes
|
|
149
|
+
------------- | ------------- | ------------- | -------------
|
|
150
|
+
**product_html_description_request** | [**ProductHtmlDescriptionRequest**](ProductHtmlDescriptionRequest.md)| The request body to get product html description |
|
|
151
|
+
|
|
152
|
+
### Return type
|
|
153
|
+
|
|
154
|
+
[**ProductHtmlDescription**](ProductHtmlDescription.md)
|
|
155
|
+
|
|
156
|
+
### Authorization
|
|
157
|
+
|
|
158
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
159
|
+
|
|
160
|
+
### HTTP request headers
|
|
161
|
+
|
|
162
|
+
- **Content-Type**: application/json
|
|
163
|
+
- **Accept**: application/json
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
# **get_product_reviews**
|
|
168
|
+
> ProductReviews get_product_reviews(product_reviews_request)
|
|
169
|
+
|
|
170
|
+
Get product reviews from AliExpress in realtime
|
|
171
|
+
|
|
172
|
+
### Example
|
|
173
|
+
```ruby
|
|
174
|
+
# load the gem
|
|
175
|
+
require 'aliseeks_api'
|
|
176
|
+
# setup authorization
|
|
177
|
+
AliseeksApi.configure do |config|
|
|
178
|
+
# Configure API key authorization: ApiKeyAuth
|
|
179
|
+
config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
|
|
180
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
181
|
+
#config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
|
|
182
|
+
end
|
|
183
|
+
|
|
184
|
+
api_instance = AliseeksApi::ProductsApi.new
|
|
185
|
+
product_reviews_request = AliseeksApi::ProductReviewsRequest.new # ProductReviewsRequest | The request body to get product reviews
|
|
186
|
+
|
|
187
|
+
begin
|
|
188
|
+
#Get product reviews from AliExpress in realtime
|
|
189
|
+
result = api_instance.get_product_reviews(product_reviews_request)
|
|
190
|
+
p result
|
|
191
|
+
rescue AliseeksApi::ApiError => e
|
|
192
|
+
puts "Exception when calling ProductsApi->get_product_reviews: #{e}"
|
|
193
|
+
end
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Parameters
|
|
197
|
+
|
|
198
|
+
Name | Type | Description | Notes
|
|
199
|
+
------------- | ------------- | ------------- | -------------
|
|
200
|
+
**product_reviews_request** | [**ProductReviewsRequest**](ProductReviewsRequest.md)| The request body to get product reviews |
|
|
201
|
+
|
|
202
|
+
### Return type
|
|
203
|
+
|
|
204
|
+
[**ProductReviews**](ProductReviews.md)
|
|
205
|
+
|
|
206
|
+
### Authorization
|
|
207
|
+
|
|
208
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
209
|
+
|
|
210
|
+
### HTTP request headers
|
|
211
|
+
|
|
212
|
+
- **Content-Type**: application/json
|
|
213
|
+
- **Accept**: application/json
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
# **get_product_shipping**
|
|
218
|
+
> ProductShipping get_product_shipping(product_shipping_request)
|
|
219
|
+
|
|
220
|
+
Gets product shipping information AliExpress in realtime.
|
|
221
|
+
|
|
222
|
+
### Example
|
|
223
|
+
```ruby
|
|
224
|
+
# load the gem
|
|
225
|
+
require 'aliseeks_api'
|
|
226
|
+
# setup authorization
|
|
227
|
+
AliseeksApi.configure do |config|
|
|
228
|
+
# Configure API key authorization: ApiKeyAuth
|
|
229
|
+
config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
|
|
230
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
231
|
+
#config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
|
|
232
|
+
end
|
|
233
|
+
|
|
234
|
+
api_instance = AliseeksApi::ProductsApi.new
|
|
235
|
+
product_shipping_request = AliseeksApi::ProductShippingRequest.new # ProductShippingRequest | The request body to get product shipping
|
|
236
|
+
|
|
237
|
+
begin
|
|
238
|
+
#Gets product shipping information AliExpress in realtime.
|
|
239
|
+
result = api_instance.get_product_shipping(product_shipping_request)
|
|
240
|
+
p result
|
|
241
|
+
rescue AliseeksApi::ApiError => e
|
|
242
|
+
puts "Exception when calling ProductsApi->get_product_shipping: #{e}"
|
|
243
|
+
end
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### Parameters
|
|
247
|
+
|
|
248
|
+
Name | Type | Description | Notes
|
|
249
|
+
------------- | ------------- | ------------- | -------------
|
|
250
|
+
**product_shipping_request** | [**ProductShippingRequest**](ProductShippingRequest.md)| The request body to get product shipping |
|
|
251
|
+
|
|
252
|
+
### Return type
|
|
253
|
+
|
|
254
|
+
[**ProductShipping**](ProductShipping.md)
|
|
255
|
+
|
|
256
|
+
### Authorization
|
|
257
|
+
|
|
258
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
259
|
+
|
|
260
|
+
### HTTP request headers
|
|
261
|
+
|
|
262
|
+
- **Content-Type**: application/json
|
|
263
|
+
- **Accept**: application/json
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
# **get_product_skus**
|
|
268
|
+
> ProductSkus get_product_skus(product_skus_request)
|
|
269
|
+
|
|
270
|
+
Gets product skus / variation information from AliExpress in realtime.
|
|
271
|
+
|
|
272
|
+
### Example
|
|
273
|
+
```ruby
|
|
274
|
+
# load the gem
|
|
275
|
+
require 'aliseeks_api'
|
|
276
|
+
# setup authorization
|
|
277
|
+
AliseeksApi.configure do |config|
|
|
278
|
+
# Configure API key authorization: ApiKeyAuth
|
|
279
|
+
config.api_key['X-API-CLIENT-ID'] = 'YOUR API KEY'
|
|
280
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
281
|
+
#config.api_key_prefix['X-API-CLIENT-ID'] = 'Bearer'
|
|
282
|
+
end
|
|
283
|
+
|
|
284
|
+
api_instance = AliseeksApi::ProductsApi.new
|
|
285
|
+
product_skus_request = AliseeksApi::ProductSkusRequest.new # ProductSkusRequest | The request body to get product skus / variations
|
|
286
|
+
|
|
287
|
+
begin
|
|
288
|
+
#Gets product skus / variation information from AliExpress in realtime.
|
|
289
|
+
result = api_instance.get_product_skus(product_skus_request)
|
|
290
|
+
p result
|
|
291
|
+
rescue AliseeksApi::ApiError => e
|
|
292
|
+
puts "Exception when calling ProductsApi->get_product_skus: #{e}"
|
|
293
|
+
end
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
### Parameters
|
|
297
|
+
|
|
298
|
+
Name | Type | Description | Notes
|
|
299
|
+
------------- | ------------- | ------------- | -------------
|
|
300
|
+
**product_skus_request** | [**ProductSkusRequest**](ProductSkusRequest.md)| The request body to get product skus / variations |
|
|
301
|
+
|
|
302
|
+
### Return type
|
|
303
|
+
|
|
304
|
+
[**ProductSkus**](ProductSkus.md)
|
|
305
|
+
|
|
306
|
+
### Authorization
|
|
307
|
+
|
|
308
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
|
309
|
+
|
|
310
|
+
### HTTP request headers
|
|
311
|
+
|
|
312
|
+
- **Content-Type**: application/json
|
|
313
|
+
- **Accept**: application/json
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|