Created
March 24, 2023 12:23
-
-
Save mkarsene/7f40e3c25a187223e84a5b4b3ab50b58 to your computer and use it in GitHub Desktop.
CS-Cart Openapi spec. There are some things that are still missing and can be improved. Please help improve.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openapi: 3.0.0 | |
info: | |
title: CS_API_COLLECTION | |
version: 1.0.0 | |
servers: | |
- url: http://{{base_url}} | |
components: | |
securitySchemes: | |
basicAuth: | |
type: http | |
scheme: basic | |
security: | |
- basicAuth: [] | |
tags: | |
- name: Products | |
- name: Categories | |
- name: Discussions | |
- name: Orders | |
- name: Users | |
- name: Vendors | |
- name: Languages | |
- name: Product Variations | |
- name: Product Variation Groups | |
- name: Pages | |
- name: Usergroups | |
- name: Taxes | |
- name: Stores | |
- name: Statuses | |
- name: Shipping Methods | |
- name: Shipments | |
- name: Settings | |
- name: Product Option Exceptions | |
- name: Product Option Combinations | |
- name: Product Options | |
- name: payments | |
- name: Product Features | |
- name: Langvars | |
- name: Blocks | |
- name: call_requests | |
- name: Carts | |
paths: | |
/api/products: | |
get: | |
tags: | |
- Products | |
summary: get_all_products | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Products | |
summary: add_product | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
min_items_in_box: 12 | |
max_items_in_box: 20 | |
box_length: 0 | |
box_width: 0 | |
box_height: 0 | |
product_code: D00014MK1P | |
product_type: P | |
status: A | |
company_id: '1' | |
list_price: '6499.99' | |
amount: '10' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893806' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: | |
- '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
parent_product_id: '0' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_id: '0' | |
master_product_status: A | |
master_product_offers_count: '0' | |
is_stock_split_by_warehouses: 'N' | |
lang_code: en | |
product: 65" Class (64.5" Diag.) LED 8000 Series Smart TV | |
shortname: '' | |
short_description: '' | |
full_description: "<p>\r\n\t For the ultimate TV enthusiasts, incredible picture quality and advanced connectivity are just the first step; the Samsung UN65D8000 LED TV goes a step beyond, adding elegant design to the formula. On the commanding 65-inch screen you can enjoy Samsung' Smart TV, which puts the web, a wide range of apps, Skype video calling, and plenty more at your fingertips. Or connect a Blu-ray 3D player to get immersed in cinema-quality 3D programming--two pairs of active glasses are included.\r\n</p>" | |
meta_keywords: '' | |
meta_description: '' | |
search_words: '' | |
page_title: '' | |
age_warning_message: '' | |
promo_text: >- | |
<p class="product-promo-text"><span | |
class="product-promo-header">FREE US shipping over | |
$100!</span><span class="product-promo-body">Orders within | |
next 2 days will be shipped on Monday</span></p> | |
unit_name: '' | |
ebay_title: null | |
ebay_description: null | |
override: null | |
price: '5399.99' | |
category_ids: | |
- 190 | |
popularity: null | |
company_name: Simtech | |
sales_amount: null | |
seo_name: 65-class-64.5-diag.-led-8000-series-smart-tv | |
seo_path: 166/174/190 | |
point_price: null | |
discussion_type: B | |
average_rating: '4.00' | |
product_reviews_count: '3' | |
base_price: '5399.99' | |
main_category: 190 | |
image_pairs: | |
'182': | |
pair_id: '182' | |
image_id: '0' | |
detailed_id: '238' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: A | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
relative_path: detailed/0/LED800065NAL30_1.jpg | |
is_high_res: false | |
'183': | |
pair_id: '183' | |
image_id: '0' | |
detailed_id: '239' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: A | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
relative_path: detailed/0/LED800065NAfront_2.jpg | |
is_high_res: false | |
'184': | |
pair_id: '184' | |
image_id: '0' | |
detailed_id: '240' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: A | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
relative_path: detailed/0/LED800065NAR30_2.jpg | |
is_high_res: false | |
main_pair: | |
pair_id: '181' | |
image_id: '0' | |
detailed_id: '237' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
alt: '' | |
image_x: '400' | |
image_y: '400' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
relative_path: detailed/0/d85_smartTV.jpg | |
is_high_res: false | |
prices: | |
- product_id: '1' | |
lower_limit: '1' | |
usergroup_id: '0' | |
percentage_discount: '0.00' | |
price: '5399.99' | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '89' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Samsung | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-89 | |
variants: | |
'89': | |
value: '' | |
value_int: null | |
variant_id: '89' | |
variant: Samsung | |
image_pairs: | |
pair_id: '878' | |
image_id: '1009' | |
detailed_id: '0' | |
position: '0' | |
object_id: '89' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '68' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
relative_path: feature_variant/1/Samsung_Logo.svg.png | |
is_high_res: false | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
detailed_params: | |
info_type: D | |
is_preview: false | |
relative_vendor_rating: 0 | |
is_negative_amount_allowed: false | |
premoderation_reason: '' | |
have_required: 'N' | |
selected_options: [] | |
variation_features: [] | |
has_options: false | |
product_options: [] | |
list_discount: 1100 | |
list_discount_prc: '17' | |
discounts: | |
A: 0 | |
P: 0 | |
qty_content: [] | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/products/{product_id}: | |
get: | |
tags: | |
- Products | |
summary: get_specific_product | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Products | |
summary: update_specific_product | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
min_items_in_box: 0 | |
max_items_in_box: 0 | |
box_length: 0 | |
box_width: 0 | |
box_height: 0 | |
product_id: 1 | |
product_code: D00014MK1P | |
product_type: P | |
status: A | |
company_id: '1' | |
list_price: '6499.99' | |
amount: '10' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893806' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: | |
- '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
parent_product_id: '0' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_id: '0' | |
master_product_status: A | |
master_product_offers_count: '0' | |
is_stock_split_by_warehouses: 'N' | |
lang_code: en | |
product: 65" Class (64.5" Diag.) LED 8000 Series Smart TV | |
shortname: '' | |
short_description: '' | |
full_description: "<p>\r\n\t For the ultimate TV enthusiasts, incredible picture quality and advanced connectivity are just the first step; the Samsung UN65D8000 LED TV goes a step beyond, adding elegant design to the formula. On the commanding 65-inch screen you can enjoy Samsung' Smart TV, which puts the web, a wide range of apps, Skype video calling, and plenty more at your fingertips. Or connect a Blu-ray 3D player to get immersed in cinema-quality 3D programming--two pairs of active glasses are included.\r\n</p>" | |
meta_keywords: '' | |
meta_description: '' | |
search_words: '' | |
page_title: '' | |
age_warning_message: '' | |
promo_text: >- | |
<p class="product-promo-text"><span | |
class="product-promo-header">FREE US shipping over | |
$100!</span><span class="product-promo-body">Orders within | |
next 2 days will be shipped on Monday</span></p> | |
unit_name: '' | |
ebay_title: null | |
ebay_description: null | |
override: null | |
price: '5399.99' | |
category_ids: | |
- 190 | |
popularity: null | |
company_name: Simtech | |
sales_amount: null | |
seo_name: 65-class-64.5-diag.-led-8000-series-smart-tv | |
seo_path: 166/174/190 | |
point_price: null | |
discussion_type: B | |
average_rating: '4.00' | |
product_reviews_count: '3' | |
base_price: '5399.99' | |
main_category: 190 | |
image_pairs: | |
'182': | |
pair_id: '182' | |
image_id: '0' | |
detailed_id: '238' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: A | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAL30_1.jpg | |
relative_path: detailed/0/LED800065NAL30_1.jpg | |
is_high_res: false | |
'183': | |
pair_id: '183' | |
image_id: '0' | |
detailed_id: '239' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: A | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAfront_2.jpg | |
relative_path: detailed/0/LED800065NAfront_2.jpg | |
is_high_res: false | |
'184': | |
pair_id: '184' | |
image_id: '0' | |
detailed_id: '240' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: A | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/LED800065NAR30_2.jpg | |
relative_path: detailed/0/LED800065NAR30_2.jpg | |
is_high_res: false | |
main_pair: | |
pair_id: '181' | |
image_id: '0' | |
detailed_id: '237' | |
position: '0' | |
object_id: '1' | |
object_type: product | |
detailed: | |
object_id: '1' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
alt: '' | |
image_x: '400' | |
image_y: '400' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/d85_smartTV.jpg | |
relative_path: detailed/0/d85_smartTV.jpg | |
is_high_res: false | |
prices: | |
- product_id: '1' | |
lower_limit: '1' | |
usergroup_id: '0' | |
percentage_discount: '0.00' | |
price: '5399.99' | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '89' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Samsung | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-89 | |
variants: | |
'89': | |
value: '' | |
value_int: null | |
variant_id: '89' | |
variant: Samsung | |
image_pairs: | |
pair_id: '878' | |
image_id: '1009' | |
detailed_id: '0' | |
position: '0' | |
object_id: '89' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '68' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Samsung_Logo.svg.png | |
relative_path: feature_variant/1/Samsung_Logo.svg.png | |
is_high_res: false | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
detailed_params: | |
info_type: D | |
is_preview: false | |
relative_vendor_rating: 0 | |
is_negative_amount_allowed: false | |
premoderation_reason: '' | |
have_required: 'N' | |
selected_options: [] | |
variation_features: [] | |
has_options: false | |
product_options: [] | |
list_discount: 1100 | |
list_discount_prc: '17' | |
discounts: | |
A: 0 | |
P: 0 | |
qty_content: [] | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Products | |
summary: delete_specific_product | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/categories: | |
get: | |
tags: | |
- Categories | |
summary: get_all_categories | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Categories | |
summary: add_category | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
parent_id: '263' | |
id_path: 166/254/263/255 | |
level: '4' | |
company_id: '0' | |
storefront_id: '0' | |
usergroup_ids: '0' | |
status: A | |
product_count: '3' | |
position: '10' | |
timestamp: '1412601391' | |
is_op: 'N' | |
localization: '' | |
age_verification: 'N' | |
age_limit: '0' | |
parent_age_verification: 'N' | |
parent_age_limit: '0' | |
selected_views: [] | |
default_view: '' | |
product_details_view: default | |
product_columns: '0' | |
is_trash: 'N' | |
is_default: 'N' | |
category_type: C | |
ebay_category: null | |
lang_code: en | |
category: Microsoft | |
description: '' | |
meta_keywords: '' | |
meta_description: '' | |
page_title: '' | |
age_warning_message: '' | |
seo_name: microsoft | |
seo_path: 166/254/263 | |
main_pair: [] | |
selected_layouts: [] | |
default_layout: '' | |
product_details_layout: default | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/categories/{category_id}: | |
get: | |
tags: | |
- Categories | |
summary: get_specific_category | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: category_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Categories | |
summary: update_specific_category | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
parent_id: '263' | |
id_path: 166/254/263/255 | |
level: '4' | |
company_id: '0' | |
storefront_id: '0' | |
usergroup_ids: '0' | |
status: A | |
product_count: '3' | |
position: '10' | |
timestamp: '1412601391' | |
is_op: 'N' | |
localization: '' | |
age_verification: 'N' | |
age_limit: '0' | |
parent_age_verification: 'N' | |
parent_age_limit: '0' | |
selected_views: [] | |
default_view: '' | |
product_details_view: default | |
product_columns: '0' | |
is_trash: 'N' | |
is_default: 'N' | |
category_type: C | |
ebay_category: null | |
lang_code: en | |
category: Microsoft | |
description: '' | |
meta_keywords: '' | |
meta_description: '' | |
page_title: '' | |
age_warning_message: '' | |
seo_name: microsoft | |
seo_path: 166/254/263 | |
main_pair: [] | |
selected_layouts: [] | |
default_layout: '' | |
product_details_layout: default | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: category_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Categories | |
summary: delete_specific_category | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: category_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/categories/{category_id}/products: | |
get: | |
tags: | |
- Categories | |
summary: get_all_products_in_specific_category | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: category_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/categories/{category_id}/products/{product_id}: | |
get: | |
tags: | |
- Categories | |
summary: get_specific_product_in_specific_category | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: category_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/discussions: | |
get: | |
tags: | |
- Discussions | |
summary: get_all_discussions | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Discussions | |
summary: add_discussion | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
thread_id: '1' | |
name: Customer Customer | |
timestamp: '1129547428' | |
user_id: '3' | |
ip_address: 192.168.0.2 | |
status: A | |
message: >- | |
I first noticed this monitor at one of those computer stores | |
where they place all the monitors on the same shelf. This one | |
really stood out for color and very sharp focus. I watch | |
movies and play some games and I haven't noticed any ghosting. | |
The only thing that I wish I could do is rotate the screen for | |
word processing (kind of a minor complaint). Otherwise this is | |
a very good monitor and the price is good for a 3D LCD. | |
rating_value: '4' | |
object_id: '228' | |
object_type: P | |
type: B | |
company_id: '1' | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/discussions/{post_id}: | |
get: | |
tags: | |
- Discussions | |
summary: get_specific_discussion | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: post_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Discussions | |
summary: update_specific_discussion | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
discussions: | |
- post_id: '91' | |
thread_id: '978' | |
name: Major Tom | |
timestamp: '1484308740' | |
user_id: '0' | |
ip_address: 95.104.194.197 | |
status: A | |
message: Very good quality. | |
rating_value: '5' | |
object_id: '1' | |
object_type: P | |
type: B | |
company_id: '1' | |
- post_id: '89' | |
thread_id: '978' | |
name: Brian | |
timestamp: '1484308560' | |
user_id: '0' | |
ip_address: 95.104.194.197 | |
status: A | |
message: >- | |
Absolutely enjoy this TV. The colors are amazing: the | |
depth, the balance and everything else is just top notch! | |
I can plug in my hard drive and watch videos instantly! I | |
am still amazed at the clarity from all the angles. Just | |
getting into Blue-ray capabilities now. Although the price | |
is relatively high, I can truly say that it's a stunning | |
piece of technological craftsmanship. | |
rating_value: '4' | |
object_id: '1' | |
object_type: P | |
type: B | |
company_id: '1' | |
- post_id: '90' | |
thread_id: '978' | |
name: J. Bond | |
timestamp: '1484308560' | |
user_id: '0' | |
ip_address: 95.104.194.197 | |
status: A | |
message: >- | |
Broke the next day. It probably got damaged during | |
shipping. I had to ask for a replacement, and it has just | |
arrived today. So far so good. | |
rating_value: '3' | |
object_id: '1' | |
object_type: P | |
type: B | |
company_id: '1' | |
params: | |
page: 1 | |
items_per_page: 50 | |
company_id: '' | |
ajax_custom: '1' | |
object_id: 1 | |
object_type: P | |
sort_order: desc | |
sort_by: timestamp | |
sort_order_rev: asc | |
total_items: '3' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: post_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Discussions | |
summary: delete_specific_discussion | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: post_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/products/{product_id}/discussions: | |
get: | |
tags: | |
- Discussions | |
summary: get_all_discussions_in_specific_product | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Discussions | |
summary: add_discussions_in_specific_product | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
discussions: | |
- post_id: '91' | |
thread_id: '978' | |
name: Major Tom | |
timestamp: '1484308740' | |
user_id: '0' | |
ip_address: 95.104.194.197 | |
status: A | |
message: Very good quality. | |
rating_value: '5' | |
object_id: '1' | |
object_type: P | |
type: B | |
company_id: '1' | |
- post_id: '89' | |
thread_id: '978' | |
name: Brian | |
timestamp: '1484308560' | |
user_id: '0' | |
ip_address: 95.104.194.197 | |
status: A | |
message: >- | |
Absolutely enjoy this TV. The colors are amazing: the | |
depth, the balance and everything else is just top notch! | |
I can plug in my hard drive and watch videos instantly! I | |
am still amazed at the clarity from all the angles. Just | |
getting into Blue-ray capabilities now. Although the price | |
is relatively high, I can truly say that it's a stunning | |
piece of technological craftsmanship. | |
rating_value: '4' | |
object_id: '1' | |
object_type: P | |
type: B | |
company_id: '1' | |
- post_id: '90' | |
thread_id: '978' | |
name: J. Bond | |
timestamp: '1484308560' | |
user_id: '0' | |
ip_address: 95.104.194.197 | |
status: A | |
message: >- | |
Broke the next day. It probably got damaged during | |
shipping. I had to ask for a replacement, and it has just | |
arrived today. So far so good. | |
rating_value: '3' | |
object_id: '1' | |
object_type: P | |
type: B | |
company_id: '1' | |
params: | |
page: 1 | |
items_per_page: 50 | |
company_id: '' | |
ajax_custom: '1' | |
object_id: 1 | |
object_type: P | |
sort_order: desc | |
sort_by: timestamp | |
sort_order_rev: asc | |
total_items: '3' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'201': | |
description: Created | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/products/{product_id}/discussions/{post_id}: | |
get: | |
tags: | |
- Discussions | |
summary: get_specific_discussion_in_specific_product | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: post_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Discussions | |
summary: update_specific_discussion_in_specific_product | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
thread_id: '978' | |
name: J. Bond | |
timestamp: '1484308560' | |
user_id: '0' | |
ip_address: 95.104.194.197 | |
status: A | |
message: >- | |
Broke the next day. It probably got damaged during shipping. I | |
had to ask for a replacement, and it has just arrived today. | |
So far so good. | |
rating_value: '3' | |
object_id: '1' | |
object_type: P | |
type: B | |
company_id: '1' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: post_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Discussions | |
summary: delete_specific_discussion_in_specific_product | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: post_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:55:40 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: {} | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/orders: | |
get: | |
tags: | |
- Orders | |
summary: get_all_orders | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Orders | |
summary: create_Multi-Vendor_order_with_coupon | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
user_id: '3' | |
shipping_id: '1' | |
payment_id: '2' | |
products: | |
'1': | |
product_id: '12' | |
amount: '5' | |
'2': | |
product_id: '13' | |
amount: '2' | |
coupon_codes: | |
'1': '123' | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/orders/52: | |
get: | |
tags: | |
- Orders | |
summary: get_specific_order | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/orders/{order_id}: | |
put: | |
tags: | |
- Orders | |
summary: update_Multi-Vendor_order_with_notification | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
user_id: '3' | |
shipping_id: '1' | |
payment_id: '2' | |
products: | |
'1': | |
product_id: '300' | |
amount: '1' | |
status: P | |
notify_user: '1' | |
notify_department: '1' | |
notify_vendor: '1' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: order_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Orders | |
summary: delete_Multi-Vendor_order | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: order_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/stores/{company_id}/orders: | |
post: | |
tags: | |
- Orders | |
summary: create_cs_cart_order_as_a_guest | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
user_id: '0' | |
payment_id: '2' | |
shipping_id: '1' | |
products: | |
'1': | |
product_id: '12' | |
amount: '1' | |
'2': | |
product_id: '13' | |
amount: '2' | |
user_data: | |
email: guest@example.com | |
firstname: Guest | |
lastname: Guest | |
s_firstname: Guest | |
s_lastname: Guest | |
s_country: US | |
s_city: Boston | |
s_state: MA | |
s_zipcode: '02125' | |
s_address: 44 Main street | |
b_firstname: Guest | |
b_lastname: Guest | |
b_country: US | |
b_city: Boston | |
b_state: MA | |
b_zipcode: '02125' | |
b_address: 44 Main street | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: company_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/stores/{company_id}/orders/{order_id}: | |
put: | |
tags: | |
- Orders | |
summary: update_cs_cart_order | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
'1': | |
product_id: '12' | |
amount: '1' | |
'3': | |
product_id: '241' | |
amount: '1' | |
product_options: | |
'12': '44' | |
'13': '48' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: company_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: order_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Orders | |
summary: delete_cs_cart_order | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: company_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: order_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
headers: | |
Server: | |
schema: | |
type: string | |
example: nginx | |
Date: | |
schema: | |
type: string | |
example: Mon, 13 Mar 2023 00:45:24 GMT | |
Content-Type: | |
schema: | |
type: string | |
example: application/json | |
Transfer-Encoding: | |
schema: | |
type: string | |
example: chunked | |
Connection: | |
schema: | |
type: string | |
example: keep-alive | |
X-Powered-By: | |
schema: | |
type: string | |
example: PHP/7.4.33 | |
X-Frame-Options: | |
schema: | |
type: string | |
example: SAMEORIGIN | |
Content-Security-Policy: | |
schema: | |
type: string | |
example: frame-ancestors 'self'; | |
Content-Encoding: | |
schema: | |
type: string | |
example: gzip | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
products: | |
- product_id: '12' | |
product: 100g Pants | |
product_type: P | |
parent_product_id: '0' | |
master_product_offers_count: '0' | |
master_product_id: '0' | |
company_id: '1' | |
product_code: U0012O5AF0 | |
status: A | |
list_price: '31.00' | |
amount: '4' | |
weight: '0.000' | |
length: '0' | |
width: '0' | |
height: '0' | |
shipping_freight: '0.00' | |
low_avail_limit: '0' | |
timestamp: '1328558400' | |
updated_timestamp: '1383893547' | |
usergroup_ids: '0' | |
is_edp: 'N' | |
edp_shipping: 'N' | |
unlimited_download: 'N' | |
tracking: B | |
free_shipping: 'N' | |
zero_price_action: R | |
is_pbp: 'Y' | |
is_op: 'N' | |
is_oper: 'N' | |
is_returnable: 'Y' | |
return_period: '10' | |
avail_since: '0' | |
out_of_stock_actions: 'N' | |
localization: '' | |
min_qty: '0' | |
max_qty: '0' | |
qty_step: '0' | |
list_qty_count: '0' | |
tax_ids: '6' | |
age_verification: 'N' | |
age_limit: '0' | |
options_type: P | |
exceptions_type: F | |
details_layout: default | |
shipping_params: >- | |
a:5:{s:16:"min_items_in_box";i:0;s:16:"max_items_in_box";i:0;s:10:"box_length";i:0;s:9:"box_width";i:0;s:10:"box_height";i:0;} | |
facebook_obj_type: '' | |
buy_now_url: '' | |
units_in_product: '0.000' | |
show_price_per_x_units: '1.000' | |
ebay_template_id: '0' | |
product_hash: '' | |
ebay_price: null | |
package_type: Letter | |
ebay_status: null | |
ebay_override_price: 'N' | |
master_product_status: A | |
is_stock_split_by_warehouses: 'N' | |
price: '30.00' | |
unit_name: '' | |
category_ids: | |
- 224 | |
seo_name: 100g-pants | |
seo_path: 223/224 | |
main_category: 224 | |
options_type_raw: null | |
exceptions_type_raw: null | |
tracking_raw: null | |
zero_price_action_raw: null | |
min_qty_raw: null | |
max_qty_raw: null | |
qty_step_raw: null | |
list_qty_count_raw: null | |
details_layout_raw: default | |
variation_features: [] | |
main_pair: | |
pair_id: '823' | |
image_id: '0' | |
detailed_id: '879' | |
position: '0' | |
object_id: '12' | |
object_type: product | |
detailed: | |
object_id: '12' | |
object_type: product | |
type: M | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
alt: '' | |
image_x: '500' | |
image_y: '500' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/detailed/0/173283_0113298267324f438bac97eaf.jpg | |
relative_path: detailed/0/173283_0113298267324f438bac97eaf.jpg | |
is_high_res: false | |
base_price: '30.00' | |
selected_options: [] | |
has_options: true | |
product_options: [] | |
list_discount: 1 | |
list_discount_prc: '3' | |
discounts: | |
A: 0 | |
P: 0 | |
product_features: | |
'18': | |
feature_id: '18' | |
value: '' | |
value_int: null | |
variant_id: '86' | |
feature_type: E | |
internal_name: Brand | |
description: Brand | |
prefix: '' | |
suffix: '' | |
variant: Adidas | |
parent_id: '0' | |
display_on_header: 'Y' | |
display_on_catalog: 'N' | |
display_on_product: 'N' | |
feature_code: '' | |
purpose: organize_catalog | |
features_hash: 10-86 | |
variants: | |
'86': | |
value: '' | |
value_int: null | |
variant_id: '86' | |
variant: Adidas | |
image_pairs: | |
pair_id: '875' | |
image_id: '1006' | |
detailed_id: '0' | |
position: '0' | |
object_id: '86' | |
object_type: feature_variant | |
icon: | |
image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
alt: '' | |
image_x: '200' | |
image_y: '133' | |
http_image_path: >- | |
http://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
https_image_path: >- | |
https://dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
absolute_path: >- | |
/var/www/html/dev.XXXXXXXXXX.org/images/feature_variant/1/Adidas_Logo.svg.png | |
relative_path: feature_variant/1/Adidas_Logo.svg.png | |
is_high_res: false | |
qty_content: [] | |
premoderation_reason: '' | |
params: | |
area: A | |
use_caching: true | |
extend: | |
- product_name | |
- prices | |
- categories | |
- categories | |
custom_extend: [] | |
pname: 'Y' | |
pshort: 'Y' | |
pfull: 'Y' | |
pkeywords: 'Y' | |
feature: [] | |
type: simple | |
page: 1 | |
action: '' | |
filter_variants: [] | |
features_hash: '' | |
limit: 0 | |
bid: 0 | |
match: all | |
tracking: [] | |
get_frontend_urls: false | |
items_per_page: 50 | |
apply_disabled_filters: '' | |
load_products_extra_data: true | |
storefront: null | |
company_ids: '' | |
show_master_products_only: false | |
subcats: 'Y' | |
pcode_from_q: 'Y' | |
search_performed: 'Y' | |
ajax_custom: '1' | |
get_detailed_warehouses_amounts: false | |
runtime_company_id: 0 | |
hide_out_of_stock_products: false | |
sort_by: product | |
sort_order: asc | |
usergroup_ids: [] | |
include_child_variations: true | |
group_child_variations: false | |
sort_order_rev: desc | |
total_items: '250' | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/users: | |
get: | |
tags: | |
- Users | |
summary: get_all_users | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Users | |
summary: create_user | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
user_login: admin | |
is_root: 'Y' | |
timestamp: '1674897730' | |
user_type: A | |
status: A | |
firstname: Admin | |
lastname: Admin | |
email: xxxxxx@gmail.com | |
company: Your company | |
company_id: '0' | |
phone: +55(55)5555-5555 | |
last_login: '1678576763' | |
company_name: null | |
points: '0' | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/users/{user_id}: | |
get: | |
tags: | |
- Users | |
summary: get_specific_user | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Users | |
summary: update_specific_user | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
user_login: admin | |
is_root: 'Y' | |
timestamp: '1674897730' | |
user_type: A | |
status: A | |
firstname: Admin | |
lastname: Admin | |
email: xxxxxx@gmail.com | |
company: Your company | |
company_id: '0' | |
phone: +55(55)5555-5555 | |
last_login: '1678576763' | |
company_name: null | |
points: '0' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Users | |
summary: delete_user | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/vendors: | |
get: | |
tags: | |
- Vendors | |
summary: get_all_vendors | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Vendors | |
summary: create_a_vendor | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
lang_code: en | |
email: simtech@example.com | |
company: Simtech | |
timestamp: '1269610461' | |
status: S | |
tax_number: '' | |
stripe_connect_account_id: '' | |
absolute_vendor_rating: null | |
plan: Gold | |
seo_name: simtech | |
seo_path: '' | |
average_rating: null | |
company_thread_ids: '1_0' | |
paypal_verification: not_checked | |
paypal_email: '' | |
ppa_first_name: '' | |
ppa_last_name: '' | |
suspend_date: '1678576763' | |
last_time_suspended: '1678576763' | |
relative_vendor_rating: 0 | |
discussion: | |
posts_count: 0 | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/vendors/{company_id}: | |
get: | |
tags: | |
- Vendors | |
summary: get_specific_vendor | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: company_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Vendors | |
summary: update_vendor | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
lang_code: en | |
email: simtech@example.com | |
company: Simtech | |
timestamp: '1269610461' | |
status: S | |
tax_number: '' | |
stripe_connect_account_id: '' | |
absolute_vendor_rating: null | |
plan: Gold | |
seo_name: simtech | |
seo_path: '' | |
average_rating: null | |
company_thread_ids: '1_0' | |
paypal_verification: not_checked | |
paypal_email: '' | |
ppa_first_name: '' | |
ppa_last_name: '' | |
suspend_date: '1678576763' | |
last_time_suspended: '1678576763' | |
relative_vendor_rating: 0 | |
discussion: | |
posts_count: 0 | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: company_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Vendors | |
summary: delete_vendor | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: company_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/languages/: | |
get: | |
tags: | |
- Languages | |
summary: get_all_languages | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Languages | |
summary: create_a_language | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
lang_code: en | |
name: English | |
status: A | |
country_code: US | |
direction: ltr | |
storefront_ids: '' | |
storefront_ids_raw: [] | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/languages/{lang_id}: | |
get: | |
tags: | |
- Languages | |
summary: get_specific_language | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: lang_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Languages | |
summary: update_language | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
lang_code: en | |
name: English | |
status: A | |
country_code: US | |
direction: ltr | |
storefront_ids: '' | |
storefront_ids_raw: [] | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: lang_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Languages | |
summary: delete_language | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: lang_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations: | |
get: | |
tags: | |
- Product Variations | |
summary: get_all_product_variations | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations/{product_id}: | |
get: | |
tags: | |
- Product Variations | |
summary: get_specific_product_variation | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations_groups/{variation_group_id}/product_variations: | |
get: | |
tags: | |
- Product Variations | |
summary: get_all_product_variations_in_specific_product_variations_group | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: variation_group_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations_groups/{variation_group_id}/product_variations/{product_id}: | |
get: | |
tags: | |
- Product Variations | |
summary: >- | |
get_all_product_variations_in_specific_product_variations_group_with_code | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: variation_group_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations_groups/{code}/product_variations: | |
get: | |
tags: | |
- Product Variations | |
summary: get_specific_product_variations_in_specific_product_variations_group | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: code | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations_groups/{code}/product_variations/{product_id}: | |
get: | |
tags: | |
- Product Variations | |
summary: >- | |
get_specific_product_variations_in_specific_product_variations_group_code | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: code | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations_groups: | |
get: | |
tags: | |
- Product Variation Groups | |
summary: get_all_product_variations_groups | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations_groups/{variation_group_id}: | |
get: | |
tags: | |
- Product Variation Groups | |
summary: get_specific_product_variations_group | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: variation_group_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/product_variations_groups/{code}: | |
get: | |
tags: | |
- Product Variation Groups | |
summary: get_specific_product_variations_group_with_code | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: code | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/pages: | |
get: | |
tags: | |
- Pages | |
summary: get_all_pages | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Pages | |
summary: create_a_pages | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '0' | |
parent_id: '0' | |
id_path: '1' | |
status: A | |
page_type: T | |
position: '0' | |
timestamp: '1208808000' | |
usergroup_ids: '0' | |
localization: '' | |
new_window: '0' | |
use_avail_period: 'N' | |
avail_from_timestamp: '0' | |
avail_till_timestamp: '0' | |
facebook_obj_type: '' | |
lang_code: en | |
page: Our team | |
description: We have the best team ever! | |
meta_keywords: '' | |
meta_description: '' | |
page_title: '' | |
link: '' | |
seo_name: our-team | |
seo_path: '' | |
tilda_description: null | |
tilda_page_id: null | |
is_only_content: null | |
tilda_project_id: null | |
tilda_published: null | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/pages/{page_id}: | |
get: | |
tags: | |
- Pages | |
summary: get_specific_pages | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: page_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Pages | |
summary: update_pages | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '0' | |
parent_id: '0' | |
id_path: '1' | |
status: A | |
page_type: T | |
position: '0' | |
timestamp: '1208808000' | |
usergroup_ids: '0' | |
localization: '' | |
new_window: '0' | |
use_avail_period: 'N' | |
avail_from_timestamp: '0' | |
avail_till_timestamp: '0' | |
facebook_obj_type: '' | |
lang_code: en | |
page: Our team | |
description: We have the best team ever! | |
meta_keywords: '' | |
meta_description: '' | |
page_title: '' | |
link: '' | |
seo_name: our-team | |
seo_path: '' | |
tilda_description: null | |
tilda_page_id: null | |
is_only_content: null | |
tilda_project_id: null | |
tilda_published: null | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: page_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Pages | |
summary: delete_pages | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: page_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/usergroups: | |
get: | |
tags: | |
- Usergroups | |
summary: get_all_usergroups | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Usergroups | |
summary: create_a_usergroups | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
status: A | |
type: C | |
usergroup: Guest | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/usergroups/{usergroup_id}: | |
get: | |
tags: | |
- Usergroups | |
summary: get_specific_usergroups | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: usergroup_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Usergroups | |
summary: update_usergroups | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
status: A | |
type: C | |
usergroup: Guest | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: usergroup_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Usergroups | |
summary: delete_usergroups | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: usergroup_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/users/{user_id}/usergroups: | |
get: | |
tags: | |
- Usergroups | |
summary: get_usergroups_for_specific_user | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/users/{user_id}/usergroups/{usergroup_id}: | |
put: | |
tags: | |
- Usergroups | |
summary: update_user_to_usergroup | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
status: A | |
type: C | |
usergroup: Guest | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: usergroup_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Usergroups | |
summary: delete_usergroups_from_user | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: usergroup_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/taxes: | |
get: | |
tags: | |
- Taxes | |
summary: get_all_taxes | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Taxes | |
summary: create_a_taxes | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
address_type: S | |
status: A | |
price_includes_tax: 'Y' | |
display_including_tax: 'N' | |
display_info: '' | |
regnumber: '1234242' | |
priority: '0' | |
tax: VAT | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/taxes/{tax_id}: | |
get: | |
tags: | |
- Taxes | |
summary: get_specific_taxes | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: tax_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Taxes | |
summary: update_taxes | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
address_type: S | |
status: A | |
price_includes_tax: 'Y' | |
display_including_tax: 'N' | |
display_info: '' | |
regnumber: '1234242' | |
priority: '0' | |
tax: VAT | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: tax_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Taxes | |
summary: delete_taxes | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: tax_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/stores: | |
get: | |
tags: | |
- Stores | |
summary: get_all_stores | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Stores | |
summary: create_a_stores | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '1' | |
lang_code: en | |
email: simtech@example.com | |
company: Simtech | |
timestamp: '1269610461' | |
status: S | |
tax_number: '' | |
stripe_connect_account_id: '' | |
absolute_vendor_rating: null | |
plan: Gold | |
seo_name: simtech | |
seo_path: '' | |
average_rating: null | |
company_thread_ids: '1_0' | |
paypal_verification: not_checked | |
paypal_email: '' | |
ppa_first_name: '' | |
ppa_last_name: '' | |
suspend_date: '1678576763' | |
last_time_suspended: '1678576763' | |
relative_vendor_rating: 0 | |
discussion: | |
posts_count: 0 | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/stores/{store_id}: | |
get: | |
tags: | |
- Stores | |
summary: get_specific_stores | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: store_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Stores | |
summary: update_stores | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '1' | |
lang_code: en | |
email: simtech@example.com | |
company: Simtech | |
timestamp: '1269610461' | |
status: S | |
tax_number: '' | |
stripe_connect_account_id: '' | |
absolute_vendor_rating: null | |
plan: Gold | |
seo_name: simtech | |
seo_path: '' | |
average_rating: null | |
company_thread_ids: '1_0' | |
paypal_verification: not_checked | |
paypal_email: '' | |
ppa_first_name: '' | |
ppa_last_name: '' | |
suspend_date: '1678576763' | |
last_time_suspended: '1678576763' | |
relative_vendor_rating: 0 | |
discussion: | |
posts_count: 0 | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: store_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Stores | |
summary: delete_stores | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: store_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/statuses: | |
get: | |
tags: | |
- Statuses | |
summary: get_all_statuses | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Statuses | |
summary: create_a_statuses | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
status: P | |
type: O | |
is_default: 'Y' | |
position: '0' | |
description: Paid | |
email_subj: has been paid | |
email_header: Your order has been paid successfully. | |
lang_code: en | |
params: | |
allow_return: 'N' | |
repay: 'N' | |
gift_cert_status: P | |
inventory: D | |
color: '#97cf4d' | |
remove_cc_info: 'Y' | |
payment_received: 'Y' | |
is_editable_inventory: 'N' | |
inventory_info: default_decline_inventory_info | |
calculate_for_payouts: 'Y' | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/statuses/{status_id}: | |
get: | |
tags: | |
- Statuses | |
summary: get_specific_statuses | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: status_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Statuses | |
summary: update_statuses | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
status: P | |
type: O | |
is_default: 'Y' | |
position: '0' | |
description: Paid | |
email_subj: has been paid | |
email_header: Your order has been paid successfully. | |
lang_code: en | |
params: | |
allow_return: 'N' | |
repay: 'N' | |
gift_cert_status: P | |
inventory: D | |
color: '#97cf4d' | |
remove_cc_info: 'Y' | |
payment_received: 'Y' | |
is_editable_inventory: 'N' | |
inventory_info: default_decline_inventory_info | |
calculate_for_payouts: 'Y' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: status_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Statuses | |
summary: delete_statuses | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: status_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/shippings: | |
get: | |
tags: | |
- Shipping Methods | |
summary: get_all_shippings | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Shipping Methods | |
summary: create_a_shippings | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '0' | |
destination: I | |
min_weight: '0.000' | |
max_weight: '0.000' | |
usergroup_ids: '0' | |
rate_calculation: M | |
service_id: '0' | |
service_params: '' | |
localization: '' | |
tax_ids: | |
- '6' | |
position: '0' | |
status: A | |
free_shipping: 'N' | |
is_address_required: 'Y' | |
available_for_new_vendors: 'N' | |
shipping: Custom shipping method | |
description: >- | |
<p>Delivery time is calculated in business | |
days.</p><p>Products in stock will be sent after the payment | |
is verified. Mail service is responsible for the goods during | |
transportation.</p><p>Please, open the package delivered under | |
your order the moment you receive it. If any damage is | |
revealed, make claims against mail service.</p><p>Any | |
questions? Contact our Customer Service at 123-12-23</p> | |
delivery_time: 3-5 days | |
allow_multiple_locations: true | |
icon: [] | |
rates: | |
'1': | |
destination_id: '1' | |
status: A | |
localization: '' | |
destination: Default rate area (all countries) | |
rate_id: '45' | |
rate_value: | |
C: | |
'0': | |
range_from_value: 0 | |
range_to_value: 100 | |
value: '0.00' | |
'100': | |
range_from_value: 100 | |
range_to_value: '' | |
value: '25.45' | |
rates_defined: '1' | |
base_rate: '0.00' | |
'7': | |
destination_id: '7' | |
status: A | |
localization: '' | |
destination: USA | |
rate_id: '1' | |
rate_value: | |
C: | |
'0': | |
range_from_value: 0 | |
range_to_value: 30 | |
value: 40 | |
'30': | |
range_from_value: 30 | |
range_to_value: 50 | |
value: 10 | |
'50': | |
range_from_value: 50 | |
range_to_value: '' | |
value: 5 | |
I: | |
'0': | |
range_from_value: 0 | |
range_to_value: 10 | |
value: 23 | |
'10': | |
range_from_value: 10 | |
range_to_value: '' | |
value: 15 | |
rates_defined: '1' | |
base_rate: '0.00' | |
'8': | |
destination_id: '8' | |
status: A | |
localization: '' | |
destination: Canada | |
rate_id: '11' | |
rate_value: | |
W: | |
- range_from_value: 0 | |
range_to_value: '' | |
value: 10 | |
I: | |
- range_from_value: 0 | |
range_to_value: '' | |
value: 15 | |
rates_defined: '1' | |
base_rate: '0.00' | |
storefront_ids: '' | |
disable_payment_ids: [] | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/shippings/{shipping_id}: | |
get: | |
tags: | |
- Shipping Methods | |
summary: get_specific_shippings | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: shipping_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Shipping Methods | |
summary: update_shippings | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '0' | |
destination: I | |
min_weight: '0.000' | |
max_weight: '0.000' | |
usergroup_ids: '0' | |
rate_calculation: M | |
service_id: '0' | |
service_params: '' | |
localization: '' | |
tax_ids: | |
- '6' | |
position: '0' | |
status: A | |
free_shipping: 'N' | |
is_address_required: 'Y' | |
available_for_new_vendors: 'N' | |
shipping: Custom shipping method | |
description: >- | |
<p>Delivery time is calculated in business | |
days.</p><p>Products in stock will be sent after the payment | |
is verified. Mail service is responsible for the goods during | |
transportation.</p><p>Please, open the package delivered under | |
your order the moment you receive it. If any damage is | |
revealed, make claims against mail service.</p><p>Any | |
questions? Contact our Customer Service at 123-12-23</p> | |
delivery_time: 3-5 days | |
allow_multiple_locations: true | |
icon: [] | |
rates: | |
'1': | |
destination_id: '1' | |
status: A | |
localization: '' | |
destination: Default rate area (all countries) | |
rate_id: '45' | |
rate_value: | |
C: | |
'0': | |
range_from_value: 0 | |
range_to_value: 100 | |
value: '0.00' | |
'100': | |
range_from_value: 100 | |
range_to_value: '' | |
value: '25.45' | |
rates_defined: '1' | |
base_rate: '0.00' | |
'7': | |
destination_id: '7' | |
status: A | |
localization: '' | |
destination: USA | |
rate_id: '1' | |
rate_value: | |
C: | |
'0': | |
range_from_value: 0 | |
range_to_value: 30 | |
value: 40 | |
'30': | |
range_from_value: 30 | |
range_to_value: 50 | |
value: 10 | |
'50': | |
range_from_value: 50 | |
range_to_value: '' | |
value: 5 | |
I: | |
'0': | |
range_from_value: 0 | |
range_to_value: 10 | |
value: 23 | |
'10': | |
range_from_value: 10 | |
range_to_value: '' | |
value: 15 | |
rates_defined: '1' | |
base_rate: '0.00' | |
'8': | |
destination_id: '8' | |
status: A | |
localization: '' | |
destination: Canada | |
rate_id: '11' | |
rate_value: | |
W: | |
- range_from_value: 0 | |
range_to_value: '' | |
value: 10 | |
I: | |
- range_from_value: 0 | |
range_to_value: '' | |
value: 15 | |
rates_defined: '1' | |
base_rate: '0.00' | |
storefront_ids: '' | |
disable_payment_ids: [] | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: shipping_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Shipping Methods | |
summary: delete_shippings | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: shipping_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/shipments: | |
get: | |
tags: | |
- Shipments | |
summary: get_all_shipments | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Shipments | |
summary: create_a_shipments | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
carrier: '0' | |
order_id: '1' | |
product_id: '1' | |
shipping_id: A | |
tracking_number: T | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/shipments/{shipping_id}: | |
get: | |
tags: | |
- Shipments | |
summary: get_specific_shipments | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: shipping_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Shipments | |
summary: update_shipments | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
carrier: '0' | |
order_id: '1' | |
product_id: '1' | |
shipping_id: A | |
tracking_number: T | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: shipping_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Shipments | |
summary: delete_shipments | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: shipping_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/settings: | |
get: | |
tags: | |
- Settings | |
summary: get_all_settings | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/settings/{object_id}: | |
get: | |
tags: | |
- Settings | |
summary: get_specific_settings | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: object_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Settings | |
summary: update_settings | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
name: company_name | |
section_id: '5' | |
section_tab_id: '0' | |
type: I | |
edition_type: ROOT,ULT:VENDOR | |
position: '0' | |
is_global: 'Y' | |
handler: '' | |
parent_id: '0' | |
description: Company name | |
tooltip: null | |
object_type: O | |
value: ZZZZZZZZ | |
section_name: Company | |
section_tab_name: main | |
variants: [] | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: object_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Settings | |
summary: delete_settings | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: object_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/exceptions/: | |
get: | |
tags: | |
- Product Option Exceptions | |
summary: get_all_exceptions | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: query | |
schema: | |
type: integer | |
example: '12' | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/exceptions/{exception_id}: | |
get: | |
tags: | |
- Product Option Exceptions | |
summary: get_specific_exceptions | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: exception_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Product Option Exceptions | |
summary: update_exceptions | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
exception_id: '5' | |
product_id: '12' | |
combination: | |
'3': '16' | |
'4': '-1' | |
'17': '-2' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: exception_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Product Option Exceptions | |
summary: delete_exceptions | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: exception_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/exceptions: | |
post: | |
tags: | |
- Product Option Exceptions | |
summary: create_a_exceptions | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
exception_id: '5' | |
product_id: '12' | |
combination: | |
'3': '16' | |
'4': '-1' | |
'17': '-2' | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/combinations: | |
get: | |
tags: | |
- Product Option Combinations | |
summary: get_all_combinations | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Product Option Combinations | |
summary: create_a_combinations | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
product_id: '4' | |
combination: | |
'24': '74' | |
'25': '80' | |
'26': '86' | |
amount: '34' | |
position: '10' | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/combinations/{combination_hash}: | |
get: | |
tags: | |
- Product Option Combinations | |
summary: get_specific_combinations | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: combination_hash | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Product Option Combinations | |
summary: update_combination | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
product_id: '4' | |
combination: | |
'24': '74' | |
'25': '80' | |
'26': '86' | |
amount: '34' | |
position: '10' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: combination_hash | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Product Option Combinations | |
summary: delete_combination | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: combination_hash | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/options: | |
get: | |
tags: | |
- Product Options | |
summary: get_all_options | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Product Options | |
summary: create_a_option | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
product_id: '0' | |
company_id: '1' | |
option_type: S | |
regexp: '' | |
required: 'N' | |
multiupload: 'N' | |
allowed_extensions: '' | |
max_file_size: '0' | |
missing_variants_handling: M | |
status: A | |
position: '10' | |
value: '' | |
google_export_name_option: '' | |
lang_code: en | |
option_name: Color | |
internal_option_name: Monotone color | |
option_text: Color | |
description: null | |
comment: '' | |
inner_hint: '' | |
incorrect_message: '' | |
variants: | |
'1': | |
variant_name: White | |
variant_id: '1' | |
option_id: '1' | |
position: '10' | |
modifier: '0.000' | |
modifier_type: A | |
weight_modifier: '0.000' | |
weight_modifier_type: A | |
point_modifier: '0.000' | |
point_modifier_type: A | |
status: A | |
image_pair: [] | |
'11': | |
variant_name: Yellow | |
variant_id: '11' | |
option_id: '1' | |
position: '60' | |
modifier: '0.000' | |
modifier_type: A | |
weight_modifier: '0.000' | |
weight_modifier_type: A | |
point_modifier: '0.000' | |
point_modifier_type: A | |
status: A | |
image_pair: [] | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/options/{product_id}: | |
get: | |
tags: | |
- Product Options | |
summary: get_specific_product_options | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/options/{option_id}: | |
get: | |
tags: | |
- Product Options | |
summary: get_specific_options | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: option_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Product Options | |
summary: update_option | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
product_id: '0' | |
company_id: '1' | |
option_type: S | |
regexp: '' | |
required: 'N' | |
multiupload: 'N' | |
allowed_extensions: '' | |
max_file_size: '0' | |
missing_variants_handling: M | |
status: A | |
position: '10' | |
value: '' | |
google_export_name_option: '' | |
lang_code: en | |
option_name: Color | |
internal_option_name: Monotone color | |
option_text: Color | |
description: null | |
comment: '' | |
inner_hint: '' | |
incorrect_message: '' | |
variants: | |
'1': | |
variant_name: White | |
variant_id: '1' | |
option_id: '1' | |
position: '10' | |
modifier: '0.000' | |
modifier_type: A | |
weight_modifier: '0.000' | |
weight_modifier_type: A | |
point_modifier: '0.000' | |
point_modifier_type: A | |
status: A | |
image_pair: [] | |
'11': | |
variant_name: Yellow | |
variant_id: '11' | |
option_id: '1' | |
position: '60' | |
modifier: '0.000' | |
modifier_type: A | |
weight_modifier: '0.000' | |
weight_modifier_type: A | |
point_modifier: '0.000' | |
point_modifier_type: A | |
status: A | |
image_pair: [] | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: option_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Product Options | |
summary: delete_option | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: option_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/payments: | |
get: | |
tags: | |
- payments | |
summary: get_all_payments | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- payments | |
summary: create_a_payment | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '0' | |
usergroup_ids: '0' | |
position: '10' | |
status: A | |
template: views/orders/components/payments/cc.tpl | |
processor_id: '0' | |
processor_params: '' | |
a_surcharge: '0.000' | |
p_surcharge: '0.000' | |
tax_ids: [] | |
localization: '' | |
payment_category: tab1 | |
country_selection_mode: 'N' | |
payment: Credit card | |
description: Visa, Mastercard, etc... | |
instructions: '' | |
surcharge_title: '' | |
lang_code: en | |
processor: null | |
processor_type: null | |
processor_status: null | |
image: [] | |
storefront_ids: '' | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/payments/{payment_id}: | |
get: | |
tags: | |
- payments | |
summary: get_specific_payment | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: payment_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- payments | |
summary: update_payment | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
company_id: '0' | |
usergroup_ids: '0' | |
position: '10' | |
status: A | |
template: views/orders/components/payments/cc.tpl | |
processor_id: '0' | |
processor_params: '' | |
a_surcharge: '0.000' | |
p_surcharge: '0.000' | |
tax_ids: [] | |
localization: '' | |
payment_category: tab1 | |
country_selection_mode: 'N' | |
payment: Credit card | |
description: Visa, Mastercard, etc... | |
instructions: '' | |
surcharge_title: '' | |
lang_code: en | |
processor: null | |
processor_type: null | |
processor_status: null | |
image: [] | |
storefront_ids: '' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: payment_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- payments | |
summary: delete_payment | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: payment_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/features: | |
get: | |
tags: | |
- Product Features | |
summary: get_all_features | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Product Features | |
summary: create_a_features | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
feature_code: ebay_group_identifiers | |
company_id: '0' | |
feature_type: G | |
parent_id: '0' | |
display_on_product: 'N' | |
display_on_catalog: 'N' | |
display_on_header: 'N' | |
description: eBay product identifiers | |
internal_name: eBay product identifiers | |
lang_code: en | |
prefix: '' | |
suffix: '' | |
categories_path: '' | |
full_description: '' | |
status: A | |
comparison: 'N' | |
position: '0' | |
purpose: '' | |
feature_style: '' | |
filter_style: '' | |
variants: [] | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/products/{product_id}/features: | |
get: | |
tags: | |
- Product Features | |
summary: get_all_features_in_product | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: product_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/features/{feature_id}: | |
get: | |
tags: | |
- Product Features | |
summary: get_specific_features | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: feature_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Product Features | |
summary: update_features | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
feature_code: ebay_group_identifiers | |
company_id: '0' | |
feature_type: G | |
parent_id: '0' | |
display_on_product: 'N' | |
display_on_catalog: 'N' | |
display_on_header: 'N' | |
description: eBay product identifiers | |
internal_name: eBay product identifiers | |
lang_code: en | |
prefix: '' | |
suffix: '' | |
categories_path: '' | |
full_description: '' | |
status: A | |
comparison: 'N' | |
position: '0' | |
purpose: '' | |
feature_style: '' | |
filter_style: '' | |
variants: [] | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: feature_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Product Features | |
summary: delete_features | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: feature_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/langvars: | |
get: | |
tags: | |
- Langvars | |
summary: get_all_langvars | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Langvars | |
summary: create_a_langvars | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
lang_code: en | |
name: accept | |
value: Accept | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/langvars/{name}: | |
get: | |
tags: | |
- Langvars | |
summary: get_specific_langvars | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: name | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Langvars | |
summary: update_langvars | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
lang_code: en | |
name: English | |
status: A | |
country_code: US | |
direction: ltr | |
storefront_ids: '' | |
storefront_ids_raw: [] | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: name | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Langvars | |
summary: delete_langvars | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: name | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/languages/{lang_id}/langvars: | |
get: | |
tags: | |
- Langvars | |
summary: get_all_langvars__for_specific_language | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: lang_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Langvars | |
summary: create_a_langvars_for_specific_language | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
name: accept | |
value: Accept | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: lang_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/languages/{lang_id}/langvars/{name}: | |
get: | |
tags: | |
- Langvars | |
summary: get_specific_langvar_for_specific_language | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: lang_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: name | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Langvars | |
summary: update_langvars_for_specific_language | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
value: Accept | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: lang_id | |
in: path | |
schema: | |
type: string | |
required: true | |
- name: name | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/blocks: | |
get: | |
tags: | |
- Blocks | |
summary: list_all_blocks | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- Blocks | |
summary: create_block | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
type: languages | |
properties: | |
template: blocks/languages.tpl | |
text: '' | |
format: icon | |
dropdown_limit: '0' | |
company_id: '0' | |
storefront_id: '1' | |
lang_code: en | |
name: Languages | |
content: '' | |
availability: | |
phone: true | |
tablet: true | |
desktop: true | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/blocks/{block_id}: | |
get: | |
tags: | |
- Blocks | |
summary: get_specific_block | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: block_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- Blocks | |
summary: update_block | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
type: languages | |
properties: | |
template: blocks/languages.tpl | |
text: '' | |
format: icon | |
dropdown_limit: '0' | |
company_id: '0' | |
storefront_id: '1' | |
lang_code: en | |
name: Languages | |
content: '' | |
availability: | |
phone: true | |
tablet: true | |
desktop: true | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: block_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Blocks | |
summary: delete_block | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: block_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/call_requests: | |
get: | |
tags: | |
- call_requests | |
summary: list_all_call_requests | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
post: | |
tags: | |
- call_requests | |
summary: create_call_request | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
phone: +7(999)111-22-33 | |
name: John Doe | |
time_from: '9:00' | |
time_to: '10:00' | |
security: | |
- basicAuth: [] | |
responses: | |
'201': | |
description: Created | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/2.0/call_requests/{request_id}: | |
get: | |
tags: | |
- call_requests | |
summary: get_specific_call_request | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: request_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
put: | |
tags: | |
- call_requests | |
summary: update_call_request | |
requestBody: | |
content: | |
application/json: | |
schema: | |
type: object | |
example: | |
phone: +7(999)111-22-33 | |
name: John Doe | |
time_from: '9:00' | |
time_to: '10:00' | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: request_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'400': | |
description: Bad Request | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- call_requests | |
summary: delete_call_request | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: request_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/carts/: | |
get: | |
tags: | |
- Carts | |
summary: list_all_carts | |
security: | |
- basicAuth: [] | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
/api/carts/{user_id}: | |
get: | |
tags: | |
- Carts | |
summary: get_specific_cart | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'200': | |
description: OK | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
delete: | |
tags: | |
- Carts | |
summary: delete_cart | |
security: | |
- basicAuth: [] | |
parameters: | |
- name: user_id | |
in: path | |
schema: | |
type: string | |
required: true | |
responses: | |
'204': | |
description: No Content | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'401': | |
description: Unauthorized | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null | |
'404': | |
description: Not Found | |
content: | |
text/plain: | |
schema: | |
type: string | |
example: null |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment