Home Reference Source

References

summary
public

F error(response: Object): Object

Output Request-Promise error, used to create Promise reject

public

F output(response: Object): Object

Output Request-Promise response, used to create Promise resolve

public

Events of Request-Promise

api

summary
public

POST /admin/accessories.json

public

F editAccessory(options: Object, id: Number | String): Promise

PUT /admin/accessories/{accessory_id}.json

public

F getAccessory(options: Object, id: Number | String): Promise

GET /admin/accessories/{accessory_id}.json

public

F listAccessory(options: Object, id: Number | String): Promise

GET /admin/accessories.json

public

DELETE /admin/accessories/{accessory_id}.json

public

POST /admin/products/{product_id}/product_accessory_links.json

public

POST /admin/accessories/{accessory_id}/values.json

public

PUT /admin/accessories/{accessory_id}/values/{accessory_value_id}.json

public

GET /admin/accessories/{accessory_id}/values/{accessory_value_id}.json

public

GET /admin/products/{product_id}/product_accessory_links.json

public

GET /admin/accessories/{accessory_id}/values.json

public

DELETE /admin/products/{product_id}/product_accessory_links/{product_accessory_link_id}.json

public

DELETE /admin/accessories/{accessory_id}/values/{accessory_value_id}.json

public

F editAccount(options: Object, id: Number | String): Promise

PUT /admin/account.json

public

F getAccount(options: Object, id: number | string): Promise

GET /admin/account.xml

public

POST /admin/application_actions.json

public

PUT /admin/application_actions/{application_action_id}.json

public

GET /admin/application_actions/{application_action_id}.json

public

GET /admin/application_actions.json

public

DELETE /admin/application_actions/{application_action_id}.json

public

POST /admin/application_widgets.json

public

PUT /admin/application_widgets/{application_widget_id}.json

public

GET /admin/application_widgets/{application_widget_id}.json

public

GET /admin/application_widgets.json

public

DELETE /admin/application_widgets/{application_widget_id}.json

public

F createArticle(options: Object, id: Number | String): Promise

POST /admin/blogs/{blog_id}/articles.json

public

F editArticle(options: Object, id: Number | String): Promise

PUT /admin/blogs/{blog_id}/articles/{article_id}.json

public

F getArticle(options: Object, id: Number | String): Promise

GET /admin/blogs/{blog_id}/articles/{article_id}.json

public

F listArticle(options: Object, id: Number | String): Promise

GET /admin/blogs/{blog_id}/articles.json

public

F removeArticle(options: Object, id: Number | String): Promise

DELETE /admin/blogs/{blog_id}/articles/{article_id}.json

public

F editAsset(options: Object, id: Number | String): Promise

PUT /admin/themes/#{theme_id}/assets/#{id}.xml

public

F getAsset(options: Object, id: Number | String): Promise

GET /admin/themes/#{theme_id}/assets/#{id}.xml

public

F getAssetRaw(options: Object, id: Number | String): Promise

GET /admin/themes/#{theme_id}/assets/#{id}/raw.xml

public

F listAsset(options: Object, id: Number | String): Promise

GET /admin/themes/#{theme_id}/assets.xml

public

F removeAsset(options: Object, id: Number | String): Promise

DELETE /admin/themes/#{theme_id}/assets/#{id}.xml

public

F renameAsset(options: Object, id: Number | String): Promise

PUT /admin/themes/#{theme_id}/assets/#{id}/rename.xml

public

F uploadAsset(options: Object, id: Number | String): Promise

POST /admin/themes/#{theme_id}/assets.xml

public

F createBlog(options: Object, id: Number | String): Promise

POST /admin/blogs.json

public

F editBlog(options: Object, id: Number | String): Promise

PUT /admin/blogs/{blog_id}.json

public

F getBlog(options: Object, id: Number | String): Promise

GET /admin/blogs/{blog_id}.json

public

F listBlog(options: Object, id: Number | String): Promise

GET /admin/blogs.json

public

F removeBlog(options: Object, id: Number | String): Promise

DELETE /admin/blogs/{blog_id}.json

public

POST /admin/clients/{client_id}/bonus_system_transactions.json

public

GET /admin/bonus_system_transactions/{bst_id}.json

public

GET /admin/bonus_system_transactions.json

public

GET /admin/clients/{client_id}/bonus_system_transactions.json

public

F createCategory(options: Object, id: Number | String): Promise

POST /admin/categories.json

public

F editCategory(options: Object, id: Number | String): Promise

PUT /admin/categories/{category_id}.json

public

F getCategory(options: Object, id: Number | String): Promise

GET /admin/categories/{category_id}.json

public

F listCategory(options: Object, id: Number | String): Promise

GET /admin/categories.json

public

F removeCategory(options: Object, id: Number | String): Promise

DELETE /admin/categories/{category_id}.json

public

POST /admin/properties/{property_id}/characteristics.json

public

PUT /admin/properties/{property_id}/characteristics/{characteristic_id}.json

public

GET /admin/properties/{property_id}/characteristics/{characteristic_id}.json

public

GET /admin/properties/{property_id}/characteristics.json

public

DELETE /admin/properties/{property_id}/characteristics/{characteristic_id}.json

public

F createCharge(options: Object, id: Number | String): Promise

POST /admin/application_charges.xml

public

F declineCharge(options: Object, id: Number | String): Promise

POST /admin/application_charges/{id}/decline.xml

public

F getCharge(options: Object, id: Number | String): Promise

GET /admin/application_charges/{id}.xml

public

F listCharge(options: Object, id: Number | String): Promise

GET /admin/application_charges.xml

public

F createClient(options: Object, id: Number | String): Promise

POST /admin/clients.json

public

F editClient(options: Object, id: Number | String): Promise

PUT /admin/clients/{client_id}.json

public

F getClient(options: Object, id: Number | String): Promise

GET /admin/clients/{client_id}.json

public

F listClient(options: Object, id: Number | String): Promise

GET /admin/clients.json

public

F removeClient(options: Object, id: Number | String): Promise

DELETE /admin/clients/{client_id}.json

public

POST /admin/client_groups.json

public

PUT /admin/client_groups/{client_group_id}.json

public

F getClientGroup(options: Object, id: Number | String): Promise

GET /admin/client_groups/{client_group_id}.json

public

GET /admin/client_groups.json

public

DELETE /admin/client_groups/{client_group_id}.json

public

F createCollect(options: Object, id: Number | String): Promise

POST /admin/collects.json

public

F editCollect(options: Object, id: Number | String): Promise

PUT /admin/collects/{collect_id}.json

public

F listCollect(options: Object, id: Number | String): Promise

GET /admin/collects.json

public

F removeCollect(options: Object, id: Number | String): Promise

DELETE /admin/collects/{collect_id}.json

public

POST /admin/collections.json

public

F editCollection(options: Object, id: Number | String): Promise

PUT /admin/collections/{collection_id}.json

public

F getCollection(options: Object, id: Number | String): Promise

GET /admin/collections/{id}.xml

public

F listCollection(options: Object, id: Number | String): Promise

GET /admin/collections.xml

public

DELETE /admin/collections/{collection_id}.json

public

POST /admin/collection_fields.json

public

PUT /admin/collection_fields/{collection_field_id}.json

public

GET /admin/collection_fields/{collection_field_id}.json

public

GET /admin/collection_fields.json

public

DELETE /admin/collection_fields/{collection_field_id}.json

public

PUT /admin/collections/{collection_id}/collection_field_values/{field_id}.json

public

GET /admin/collections/{collection_id}/collection_field_values/{field_id}.json

public

GET /admin/collections/{collection_id}/collection_field_values.json

public

POST /admin/collection_filters.json

public

PUT /admin/collection_filters/{filter_id}.json

public

GET /admin/collection_filters/{filter_id}.json

public

GET /admin/collection_filters.json?collection_id={collection_id}

public

DELETE /admin/collection_filters/{filter_id}.json

public

F createCoupon(options: Object, id: Number | String): Promise

POST /admin/discount_codes.xml

public

F editCoupon(options: Object, id: Number | String): Promise

PUT /admin/discount_codes/{id}.xml

public

F getCoupon(options: Object, id: Number | String): Promise

GET /admin/discount_codes/{id}.xml

public

F listCoupon(options: Object, id: Number | String): Promise

GET /admin/discount_codes.xml

public

F removeCoupon(options: Object, id: Number | String): Promise

DELETE /admin/discount_codes/{id}.xml

public

POST /admin/custom_statuses.json

public

PUT /admin/custom_statuses/{custom_status_permalink}.json

public

GET /admin/custom_statuses/{custom_status_permalink}.json

public

GET /admin/custom_statuses.json

public

DELETE /admin/custom_statuses/{custom_status_permalink}.json

public

POST /admin/delivery_variants.json

public

PUT /admin/delivery_variants/{delivery_variant_id}.json

public

GET /admin/delivery_variants/{delivery_variant_id}.json

public

GET /admin/delivery_variants.json

public

DELETE /admin/delivery_variants/{delivery_variant_id}.json

public

F createDomain(options: Object, id: Number | String): Promise

POST /admin/domains.json

public

F editDomain(options: Object, id: Number | String): Promise

PUT /admin/domains/{domain_id}.json

public

F getDomain(options: Object, id: Number | String): Promise

GET /admin/domains/{domain_id}.json

public

F listDomain(options: Object, id: Number | String): Promise

GET /admin/domains.json

public

F removeDomain(options: Object, id: Number | String): Promise

DELETE /admin/domains/{domain_id}.json

public

POST /admin/external_discounts.json

public

PUT /admin/external_discounts/{external_discount_id}.json

public

GET /admin/external_discounts/{external_discount_id}.json

public

GET /admin/external_discounts.json

public

DELETE /admin/external_discounts/{external_discount_id}.json

public

F createField(options: Object, id: Number | String): Promise

POST /admin/fields.json

public

F editField(options: Object, id: Number | String): Promise

PUT /admin/fields/{non_select_field_id}.json

public

F getField(options: Object, id: Number | String): Promise

GET /admin/fields/{field_id}.json

public

F listField(options: Object, id: Number | String): Promise

GET /admin/fields.json

public

F removeField(options: Object, id: Number | String): Promise

DELETE /admin/fields/{field_id}.json

public

F getFile(options: Object, id: Number | String): Promise

GET /admin/files/{account_file_id}.json

public

F listFile(options: Object, id: Number | String): Promise

GET /admin/files.xml

public

F removeFile(options: Object, id: Number | String): Promise

DELETE /admin/files/{id}.xml

public

F uploadFile(options: Object, id: Number | String): Promise

POST /admin/files.xml

public

F createJsTag(options: Object, id: Number | String): Promise

POST /admin/js_tags.xml

public

F editJsTag(options: Object, id: Number | String): Promise

PUT /admin/js_tags/{js_tag_id}.json

public

F getJsTag(options: Object, id: Number | String): Promise

GET /admin/js_tags/{js_tag_id}.json

public

F listJsTag(options: Object, id: Number | String): Promise

GET /admin/js_tags.json

public

F removeJsTag(options: Object, id: Number | String): Promise

DELETE /admin/js_tags/{js_tag_id}.json

public

POST /admin/marketplaces.json

public

PUT /admin/marketplaces/{ym_marketplace_id}.json

public

F getMarketplace(options: Object, id: Number | String): Promise

GET /admin/marketplaces/{ym_marketplace_id}.json

public

GET /admin/marketplaces.json

public

DELETE /admin/marketplaces/{ym_marketplace_id}.json

public

F createMenu(options: Object, id: Number | String): Promise

POST /admin/menus.json

public

F editMenu(options: Object, id: Number | String): Promise

PUT /admin/menus/{menu_id}.json

public

F getMenu(options: Object, id: Number | String): Promise

GET /admin/menus/{menu_id}.json

public

F listMenu(options: Object, id: Number | String): Promise

GET /admin/menus.json

public

F removeMenu(options: Object, id: Number | String): Promise

DELETE /admin/menus/{menu_id}.json

public

F createMenuItem(options: Object, id: Number | String): Promise

POST /admin/menus/{menu_id}/items.json

public

F editMenuItem(options: Object, id: Number | String): Promise

PUT /admin/menus/{menu_id}/items/{item_id}.json

public

F getMenuItem(options: Object, id: Number | String): Promise

GET /admin/menus/{menu_id}/items/{item_id}.json

public

F listMenuItem(options: Object, id: Number | String): Promise

GET /admin/menus/{menu_id}/items.json

public

F removeMenuItem(options: Object, id: Number | String): Promise

DELETE /admin/menus/{menu_id}/items/{item_id}.json

public

F createOAuthApp(options: Object, id: Number | String): Promise

POST /admin/o_auth_apps.json

public

F editOAuthApp(options: Object, id: Number | String): Promise

PUT /admin/o_auth_apps/{o_auth_app_id}.json

public

F getOAuthApp(options: Object, id: Number | String): Promise

GET /admin/o_auth_apps/{o_auth_app_id}.json

public

F listOAuthApp(options: Object, id: Number | String): Promise

GET /admin/o_auth_apps.json

public

F removeOAuthApp(options: Object, id: Number | String): Promise

DELETE /admin/o_auth_apps/{o_auth_app_id}.json

public

POST /admin/option_names.json

public

F editOptionName(options: Object, id: Number | String): Promise

PUT /admin/option_names/{option_name_id}.json

public

F getOptionName(options: Object, id: Number | String): Promise

GET /admin/option_names/{option_name_id}.json

public

F listOptionName(options: Object, id: Number | String): Promise

GET /admin/option_names.json

public

DELETE /admin/option_names/{option_name_id}.json

public

POST /admin/option_names/{option_name_id}/option_values.json

public

PUT /admin/option_names/{option_name_id}/option_values/{option_value_id}.json

public

F getOptionValue(options: Object, id: Number | String): Promise

GET /admin/option_names/{option_name_id}/option_values/{option_value_id}.json

public

GET /admin/option_names/{option_name_id}/option_values/{option_value_id}/destroy_status.json

public

GET /admin/option_values.json

public

GET /admin/option_names/{option_name_id}/option_values.json

public

DELETE /admin/option_names/{option_name_id}/option_values/{option_value_id}.json

public

DELETE /admin/option_names/{option_name_id}/option_values/{option_value_id}/destroy_image.json

public

F countOrder(options: Object, id: Number | String): Promise

GET /admin/orders/count.json

public

F createOrder(options: Object, id: Number | String): Promise

POST /admin/orders.json

public

F editOrder(options: Object, id: Number | String): Promise

PUT /admin/orders/{order_id}.json

public

F getOrder(options: Object, id: Number | String): Promise

GET /admin/orders/{order_id}.json

public

F listOrder(options: Object, id: Number | String): Promise

GET /admin/orders.json

public

F createOutlet(options: Object, id: Number | String): Promise

POST /admin/outlets.json

public

F editOutlet(options: Object, id: Number | String): Promise

PUT /admin/outlets/{outlet_id}.json

public

F getOutlet(options: Object, id: Number | String): Promise

GET /admin/outlets/{outlet_id}.json

public

F listOutlet(options: Object, id: Number | String): Promise

GET /admin/outlets.json

public

F removeOutlet(options: Object, id: Number | String): Promise

DELETE /admin/outlets/{outlet_id}.json

public

F createPage(options: Object, id: Number | String): Promise

POST /admin/pages.json

public

F editPage(options: Object, id: Number | String): Promise

PUT /admin/pages/{page_id}.json

public

F getPage(options: Object, id: Number | String): Promise

GET /admin/pages/{page_id}.json

public

F listPage(options: Object, id: Number | String): Promise

GET /admin/pages.json

public

F removePage(options: Object, id: Number | String): Promise

DELETE /admin/pages/{page_id}.json

public

POST /admin/payment_gateways.json

public

PUT /admin/payment_gateways/{payment_gateway_id_1}.json

public

GET /admin/payment_gateways/{payment_gateway_id_1}.json

public

GET /admin/payment_gateways.json

public

DELETE /admin/payment_gateways/{payment_gateway_id_1}.json

public

POST /admin/price_kinds.json

public

F editPriceKind(options: Object, id: Number | String): Promise

PUT /admin/price_kinds/{id}.xml

public

F getPriceKind(options: Object, id: Number | String): Promise

GET /admin/price_kinds/{id}.json

public

F listPriceKind(options: Object, id: Number | String): Promise

GET /admin/price_kinds.json

public

DELETE /admin/price_kinds/{id}.json

public

F countProduct(options: Object, id: Number | String): Promise

GET /admin/products/count.json

public

F createProduct(options: Object, id: Number | String): Promise

POST /admin/products.xml

public

F editProduct(options: Object, id: Number | String): Promise

PUT /admin/products/{id}.xml

public

F getProduct(options: Object, id: Number | String): Promise

GET /admin/products/{id}.xml

public

F listProduct(options: Object, id: Number | String): Promise

GET /admin/products.xml

public

F removeProduct(options: Object, id: Number | String): Promise

DELETE /admin/products/{id}.xml

public

POST /admin/product_fields.json

public

PUT /admin/product_fields/{product_field_id}.json

public

GET /admin/product_fields/{product_field_id}.json

public

GET /admin/product_fields.json

public

DELETE /admin/product_fields/{product_field_id}.json

public

POST /admin/products/{product_id}/product_field_values.json

public

PUT /admin/products/{product_id}/product_field_values/{product_field_value_id}.json

public

GET /admin/products/{product_id}/product_field_values/{product_field_value_id}.json

public

GET /admin/products/{product_id}/product_field_values.json

public

DELETE /admin/products/{product_id}/product_field_values/{product_field_value_id}.json

public

POST /admin/products/{product_id}/images.json

public

PUT /admin/products/{product_id}/images/{image_id}.json

public

GET /admin/products/{product_id}/images/{image_id}.json

public

GET /admin/products/{product_id}/images.json

public

DELETE /admin/products/{product_id}/images/{image_id}.json

public

F createProperty(options: Object, id: Number | String): Promise

POST /admin/properties.json

public

F editProperty(options: Object, id: Number | String): Promise

PUT /admin/properties/{property_id}.json

public

F getProperty(options: Object, id: Number | String): Promise

GET /admin/properties/{property_id}.json

public

F listProperty(options: Object, id: Number | String): Promise

GET /admin/properties.json

public

F removeProperty(options: Object, id: Number | String): Promise

DELETE /admin/properties/{property_id}.json

public

POST /admin/dialogs/provider_tokens.json

public

PATCH /admin/recurring_application_charge/add_free_days.json

public

PUT /admin/recurring_application_charge.xml

public

POST /admin/recurring_application_charge.xml

public

F getRecurring(options: Object, id: Number | String): Promise

GET /admin/recurring_application_charge.xml

public

DELETE /admin/recurring_application_charge.xml

public

F createRedirect(options: Object, id: Number | String): Promise

POST /admin/redirects.json

public

F getRedirect(options: Object, id: Number | String): Promise

GET /admin/redirects/{redirect_id}.json

public

F listRedirect(options: Object, id: Number | String): Promise

GET /admin/redirects.json

public

F removeRedirect(options: Object, id: Number | String): Promise

DELETE /admin/redirects/{redirect_id}.json

public

F createReview(options: Object, id: Number | String): Promise

POST /admin/reviews.json

public

F editReview(options: Object, id: Number | String): Promise

PUT /admin/reviews/{review_id}.json

public

F getReview(options: Object, id: Number | String): Promise

GET /admin/reviews/{review_id}.json

public

F listReview(options: Object, id: Number | String): Promise

GET /admin/reviews.json

public

F removeReview(options: Object, id: Number | String): Promise

DELETE /admin/reviews/{review_id}.json

public

POST /admin/sales_channels.json

public

GET /admin/sales_channels/{sales_channel_id}.json

public

GET /admin/sales_channels.json

public

DELETE /admin/sales_channels/{sales_channel_id}.json

public

F createSimilar(options: Object, id: Number | String): Promise

POST /admin/products/{product_id}/similars.json

public

F listSimilar(options: Object, id: Number | String): Promise

GET /admin/products/{product_id}/similars.json

public

F removeSimilar(options: Object, id: Number | String): Promise

DELETE /admin/products/{product_id}/similars/{similar_id}.json

public

POST /admin/stock_currencies.json

public

PUT /admin/stock_currencies/{stock_currency_id}.json

public

GET /admin/stock_currencies/{stock_currency_id}.json

public

GET /admin/stock_currencies.json

public

POST /admin/products/{product_id}/supplementaries.json

public

GET /admin/products/{product_id}/supplementaries.json

public

DELETE /admin/products/{product_id}/supplementaries/{supplementary_id}.json

public

F listThemes(options: Object, id: Number | String): Promise

GET /admin/themes.xml

public

F token(token: String | Number, secret: String | Number): String

Generate access token for shop

public

F listUnit(options: Object, id: Number | String): Promise

GET /admin/units.json?lang=ru

public

F createUserTask(options: Object, id: Number | String): Promise

POST /admin/user_tasks.json

public

F editUserTask(options: Object, id: Number | String): Promise

PUT /admin/user_tasks/{user_task_id}.json

public

F getUserTask(options: Object, id: Number | String): Promise

GET /admin/user_tasks/{user_task_id}.json

public

F listUserTask(options: Object, id: Number | String): Promise

GET /admin/user_tasks.json

public

F removeUserTask(options: Object, id: Number | String): Promise

DELETE /admin/user_tasks/{user_task_id}.json

public

F createVariant(options: Object, id: Number | String): Promise

POST /admin/products/{product_id}/variants.json

public

F editVariant(options: Object, id: Number | String): Promise

PUT /admin/products/{product_id}/variants/{variant_id}.json

public

PUT /admin/products/variants_group_update.json

public

F getVariant(options: Object, id: Number | String): Promise

GET /admin/products/{product_id}/variants/{variant_id}.json

public

F listVariant(options: Object, id: Number | String): Promise

GET /admin/products/{product_id}/variants.json

public

F removeVariant(options: Object, id: Number | String): Promise

DELETE /admin/products/{product_id}/variants/{variant_success_id}.json

public

POST /admin/variant_fields.json

public

PUT /admin/variant_fields/{variant_field_id}.json

public

GET /admin/variant_fields/{variant_field_id}.json

public

GET /admin/variant_fields.json

public

DELETE /admin/variant_fields/{variant_field_id}.json

public

POST /admin/variants/{variant_id}/variant_field_values.json

public

PUT /admin/variants/{variant_id}/variant_field_values/{variant_field_value_id}.json

public

GET /admin/variants/{variant_id}/variant_field_values/{variant_field_value_id}.json

public

GET /admin/variants/{variant_id}/variant_field_values.json

public

DELETE /admin/variants/{variant_id}/variant_field_values/{variant_field_value_id}.json

public

POST /admin/warehouses.json

public

F editWarehouse(options: Object, id: Number | String): Promise

PUT /admin/warehouses/{warehouse_id}.json

public

F getWarehouse(options: Object, id: Number | String): Promise

GET /admin/warehouses/{warehouse_id}.json

public

F listWarehouse(options: Object, id: Number | String): Promise

GET /admin/warehouses.json

public

DELETE /admin/warehouses/{warehouse_id}.json

public

F createWebhook(options: Object, id: Number | String): Promise

POST /admin/webhooks.json

public

F editWebhook(options: Object, id: Number | String): Promise

PUT /admin/webhooks/{webhook_id}.json

public

F getWebhook(options: Object, id: Number | String): Promise

GET /admin/webhooks/{webhook_id}.json

public

F listWebhook(options: Object, id: Number | String): Promise

GET /admin/webhooks.json

public

F removeWebhook(options: Object, id: Number | String): Promise

DELETE /admin/webhooks/{webhook_id}.json

public

F editWidgetType(options: Object, id: Number | String): Promise

PUT /admin/themes/#{theme_id}/widget_types/#{id}.xml

public

F getWidgetType(options: Object, id: Number | String): Promise

GET /admin/themes/#{theme_id}/widget_types/#{id}.xml

public

GET /admin/themes/#{theme_id}/widget_types.xml

public

DELETE /admin/themes/#{theme_id}/widget_types/#{id}.xml

public

POST /admin/themes/#{theme_id}/widget_types.xml

methods

summary
public

F get(conn: Object): Promise

GET request

public

F patch(conn: Object): Promise

PATCH request

public

F post(conn: Object): Promise

POST request

public

F put(conn: Object): Promise

PUT request

public

F remove(conn: Object): Promise

DELETE request

Directories