6.0.0 • Published 5 years ago

@datafire/magento v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/magento

Client library for Magento Enterprise

Installation and Usage

npm install --save @datafire/magento
let magento = require('@datafire/magento').create({
  Bearer: ""
});

.then(data => {
  console.log(data);
});

Description

Magento Commerce is the leading provider of open omnichannel innovation.

Actions

customerAddressRepositoryV1DeleteByIdDelete

Delete customer address by ID.

magento.customerAddressRepositoryV1DeleteByIdDelete({
  "addressId": 0
}, context)

Input

  • input object
    • addressId required integer

Output

  • output boolean: true on success

customerCustomerMetadataV1GetAllAttributesMetadataGet

Get all attribute metadata.

magento.customerCustomerMetadataV1GetAllAttributesMetadataGet(null, context)

Input

This action has no parameters

Output

customerCustomerMetadataV1GetAttributeMetadataGet

Retrieve attribute metadata.

magento.customerCustomerMetadataV1GetAttributeMetadataGet({
  "attributeCode": ""
}, context)

Input

  • input object
    • attributeCode required string

Output

customerCustomerMetadataV1GetCustomAttributesMetadataGet

Get custom attributes metadata for the given data interface.

magento.customerCustomerMetadataV1GetCustomAttributesMetadataGet({}, context)

Input

  • input object
    • dataInterfaceName string

Output

customerCustomerMetadataV1GetAttributesGet

Retrieve all attributes filtered by form code

magento.customerCustomerMetadataV1GetAttributesGet({
  "formCode": ""
}, context)

Input

  • input object
    • formCode required string

Output

customerAddressMetadataV1GetAllAttributesMetadataGet

Get all attribute metadata.

magento.customerAddressMetadataV1GetAllAttributesMetadataGet(null, context)

Input

This action has no parameters

Output

customerAddressMetadataV1GetAttributeMetadataGet

Retrieve attribute metadata.

magento.customerAddressMetadataV1GetAttributeMetadataGet({
  "attributeCode": ""
}, context)

Input

  • input object
    • attributeCode required string

Output

customerAddressMetadataV1GetCustomAttributesMetadataGet

Get custom attributes metadata for the given data interface.

magento.customerAddressMetadataV1GetCustomAttributesMetadataGet({}, context)

Input

  • input object
    • dataInterfaceName string

Output

customerAddressMetadataV1GetAttributesGet

Retrieve all attributes filtered by form code

magento.customerAddressMetadataV1GetAttributesGet({
  "formCode": ""
}, context)

Input

  • input object
    • formCode required string

Output

bundleProductOptionManagementV1SavePost

Add new option for bundle product

magento.bundleProductOptionManagementV1SavePost({}, context)

Input

Output

  • output integer

bundleProductOptionTypeListV1GetItemsGet

Get all types for options for bundle products

magento.bundleProductOptionTypeListV1GetItemsGet(null, context)

Input

This action has no parameters

Output

bundleProductOptionManagementV1SavePut

Add new option for bundle product

magento.bundleProductOptionManagementV1SavePut({
  "optionId": ""
}, context)

Input

Output

  • output integer

bundleProductLinkManagementV1GetChildrenGet

Get all children for Bundle product

magento.bundleProductLinkManagementV1GetChildrenGet({
  "productSku": ""
}, context)

Input

  • input object
    • productSku required string
    • optionId integer

Output

bundleProductLinkManagementV1SaveChildPut

magento.bundleProductLinkManagementV1SaveChildPut({
  "sku": "",
  "id": ""
}, context)

Input

Output

  • output boolean

bundleProductLinkManagementV1AddChildByProductSkuPost

Add child product to specified Bundle option by product sku

magento.bundleProductLinkManagementV1AddChildByProductSkuPost({
  "sku": "",
  "optionId": 0
}, context)

Input

Output

  • output integer

bundleProductOptionRepositoryV1GetListGet

Get all options for bundle product

magento.bundleProductOptionRepositoryV1GetListGet({
  "sku": ""
}, context)

Input

  • input object
    • sku required string

Output

bundleProductOptionRepositoryV1DeleteByIdDelete

Remove bundle option

magento.bundleProductOptionRepositoryV1DeleteByIdDelete({
  "sku": "",
  "optionId": 0
}, context)

Input

  • input object
    • sku required string
    • optionId required integer

Output

  • output boolean

bundleProductOptionRepositoryV1GetGet

Get option for bundle product

magento.bundleProductOptionRepositoryV1GetGet({
  "sku": "",
  "optionId": 0
}, context)

Input

  • input object
    • sku required string
    • optionId required integer

Output

bundleProductLinkManagementV1RemoveChildDelete

Remove product from Bundle product option

magento.bundleProductLinkManagementV1RemoveChildDelete({
  "sku": "",
  "optionId": 0,
  "childSku": ""
}, context)

Input

  • input object
    • sku required string
    • optionId required integer
    • childSku required string

Output

  • output boolean

quoteCartManagementV1CreateEmptyCartPost

Creates an empty cart and quote for a guest.

magento.quoteCartManagementV1CreateEmptyCartPost(null, context)

Input

This action has no parameters

Output

  • output integer: Cart ID.

giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet

magento.giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet({
  "cartId": "",
  "giftCardCode": ""
}, context)

Input

  • input object
    • cartId required string
    • giftCardCode required string

Output

  • output number

giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost

magento.giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost({
  "cartId": ""
}, context)

Input

Output

  • output boolean

giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete

Remove GiftCard Account entity

magento.giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete({
  "cartId": "",
  "giftCardCode": ""
}, context)

Input

  • input object
    • cartId required string
    • giftCardCode required string

Output

  • output boolean

checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet

Lists active checkout agreements.

magento.checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet(null, context)

Input

This action has no parameters

Output

quoteCartManagementV1GetCartForCustomerGet

Returns information for the cart for a specified customer.

magento.quoteCartManagementV1GetCartForCustomerGet(null, context)

Input

This action has no parameters

Output

V1.carts.mine.post

Creates an empty cart and quote for a specified customer.

magento.V1.carts.mine.post(null, context)

Input

This action has no parameters

Output

  • output integer: Cart ID.

quoteCartRepositoryV1SavePut

Save quote

magento.quoteCartRepositoryV1SavePut({}, context)

Input

Output

customerBalanceBalanceManagementV1ApplyPost

Apply store credit

magento.customerBalanceBalanceManagementV1ApplyPost(null, context)

Input

This action has no parameters

Output

  • output boolean

V1.carts.mine.billing_address.get

Returns the billing address for a specified quote.

magento.V1.carts.mine.billing_address.get(null, context)

Input

This action has no parameters

Output

V1.carts.mine.billing_address.post

Assigns a specified billing address to a specified cart.

magento.V1.carts.mine.billing_address.post({}, context)

Input

Output

  • output integer: Address ID.

giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet

magento.giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet({
  "giftCardCode": ""
}, context)

Input

  • input object
    • giftCardCode required string

Output

  • output number

quoteCartTotalManagementV1CollectTotalsPut

Set shipping/billing methods and additional data for cart and collect totals.

magento.quoteCartTotalManagementV1CollectTotalsPut({}, context)

Input

Output

V1.carts.mine.coupons.delete

Deletes a coupon from a specified cart.

magento.V1.carts.mine.coupons.delete(null, context)

Input

This action has no parameters

Output

  • output boolean

V1.carts.mine.coupons.get

Returns information for a coupon in a specified cart.

magento.V1.carts.mine.coupons.get(null, context)

Input

This action has no parameters

Output

  • output string: The coupon code data.

V1.carts.mine.coupons.couponCode.put

Adds a coupon by code to a specified cart.

magento.V1.carts.mine.coupons.couponCode.put({
  "couponCode": ""
}, context)

Input

  • input object
    • couponCode required string: The coupon code data.

Output

  • output boolean

V1.carts.mine.estimate_shipping_methods.post

Estimate shipping by address and return list of available shipping methods

magento.V1.carts.mine.estimate_shipping_methods.post({}, context)

Input

Output

V1.carts.mine.estimate_shipping_methods_by_address_id.post

Estimate shipping

magento.V1.carts.mine.estimate_shipping_methods_by_address_id.post({}, context)

Input

  • input object
    • $body object
      • addressId required integer: The estimate address id

Output

V1.carts.mine.gift_message.get

Return the gift message for a specified order.

magento.V1.carts.mine.gift_message.get(null, context)

Input

This action has no parameters

Output

V1.carts.mine.gift_message.post

Set the gift message for an entire order.

magento.V1.carts.mine.gift_message.post({}, context)

Input

Output

  • output boolean

V1.carts.mine.gift_message.itemId.get

Return the gift message for a specified item in a specified shopping cart.

magento.V1.carts.mine.gift_message.itemId.get({
  "itemId": 0
}, context)

Input

  • input object
    • itemId required integer: The item ID.

Output

V1.carts.mine.gift_message.itemId.post

Set the gift message for a specified item in a specified shopping cart.

magento.V1.carts.mine.gift_message.itemId.post({
  "itemId": 0
}, context)

Input

Output

  • output boolean

giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost

magento.giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost({}, context)

Input

Output

  • output boolean

V1.carts.mine.giftCards.giftCardCode.delete

Remove GiftCard Account entity

magento.V1.carts.mine.giftCards.giftCardCode.delete({
  "giftCardCode": ""
}, context)

Input

  • input object
    • giftCardCode required string

Output

  • output boolean

V1.carts.mine.items.get

Lists items that are assigned to a specified cart.

magento.V1.carts.mine.items.get(null, context)

Input

This action has no parameters

Output

V1.carts.mine.items.post

Add/update the specified cart item.

magento.V1.carts.mine.items.post({}, context)

Input

Output

V1.carts.mine.items.itemId.delete

Removes the specified item from the specified cart.

magento.V1.carts.mine.items.itemId.delete({
  "itemId": 0
}, context)

Input

  • input object
    • itemId required integer: The item ID of the item to be removed.

Output

  • output boolean

V1.carts.mine.items.itemId.put

Add/update the specified cart item.

magento.V1.carts.mine.items.itemId.put({
  "itemId": ""
}, context)

Input

Output

V1.carts.mine.order.put

Places an order for a specified cart.

magento.V1.carts.mine.order.put({}, context)

Input

Output

  • output integer: Order ID.

checkoutPaymentInformationManagementV1GetPaymentInformationGet

Get payment information

magento.checkoutPaymentInformationManagementV1GetPaymentInformationGet(null, context)

Input

This action has no parameters

Output

checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost

Set payment information and place order for a specified cart.

magento.checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost({}, context)

Input

Output

  • output integer: Order ID.

V1.carts.mine.payment_methods.get

Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.

magento.V1.carts.mine.payment_methods.get(null, context)

Input

This action has no parameters

Output

V1.carts.mine.selected_payment_method.get

Returns the payment method for a specified shopping cart.

magento.V1.carts.mine.selected_payment_method.get(null, context)

Input

This action has no parameters

Output

V1.carts.mine.selected_payment_method.put

Adds a specified payment method to a specified shopping cart.

magento.V1.carts.mine.selected_payment_method.put({}, context)

Input

Output

  • output string: redirect url or error message.

checkoutPaymentInformationManagementV1SavePaymentInformationPost

Set payment information for a specified cart.

magento.checkoutPaymentInformationManagementV1SavePaymentInformationPost({}, context)

Input

Output

  • output integer: Order ID.

V1.carts.mine.shipping_information.post

magento.V1.carts.mine.shipping_information.post({}, context)

Input

Output

V1.carts.mine.shipping_methods.get

Lists applicable shipping methods for a specified quote.

magento.V1.carts.mine.shipping_methods.get(null, context)

Input

This action has no parameters

Output

V1.carts.mine.totals.get

Returns quote totals data for a specified cart.

magento.V1.carts.mine.totals.get(null, context)

Input

This action has no parameters

Output

V1.carts.mine.totals_information.post

Calculate quote totals based on address and shipping method.

magento.V1.carts.mine.totals_information.post({}, context)

Input

Output

quoteCartRepositoryV1GetListGet

Enables administrative users to list carts that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CartRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

magento.quoteCartRepositoryV1GetListGet({}, context)

Input

Output

quoteCartRepositoryV1GetGet

Enables an administrative user to return information for a specified cart.

magento.quoteCartRepositoryV1GetGet({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer

Output

quoteCartManagementV1AssignCustomerPut

Assigns a specified customer to a specified shopping cart.

magento.quoteCartManagementV1AssignCustomerPut({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.
    • $body object
      • customerId required integer: The customer ID.
      • storeId required integer

Output

  • output boolean

V1.carts.cartId.billing_address.get

Returns the billing address for a specified quote.

magento.V1.carts.cartId.billing_address.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.

Output

V1.carts.cartId.billing_address.post

Assigns a specified billing address to a specified cart.

magento.V1.carts.cartId.billing_address.post({
  "cartId": 0
}, context)

Input

Output

  • output integer: Address ID.

V1.carts.cartId.coupons.delete

Deletes a coupon from a specified cart.

magento.V1.carts.cartId.coupons.delete({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.

Output

  • output boolean

V1.carts.cartId.coupons.get

Returns information for a coupon in a specified cart.

magento.V1.carts.cartId.coupons.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.

Output

  • output string: The coupon code data.

V1.carts.cartId.coupons.couponCode.put

Adds a coupon by code to a specified cart.

magento.V1.carts.cartId.coupons.couponCode.put({
  "cartId": 0,
  "couponCode": ""
}, context)

Input

  • input object
    • cartId required integer: The cart ID.
    • couponCode required string: The coupon code data.

Output

  • output boolean

V1.carts.cartId.estimate_shipping_methods.post

Estimate shipping by address and return list of available shipping methods

magento.V1.carts.cartId.estimate_shipping_methods.post({
  "cartId": ""
}, context)

Input

Output

V1.carts.cartId.estimate_shipping_methods_by_address_id.post

Estimate shipping

magento.V1.carts.cartId.estimate_shipping_methods_by_address_id.post({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The shopping cart ID.
    • $body object
      • addressId required integer: The estimate address id

Output

V1.carts.cartId.gift_message.get

Return the gift message for a specified order.

magento.V1.carts.cartId.gift_message.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The shopping cart ID.

Output

V1.carts.cartId.gift_message.post

Set the gift message for an entire order.

magento.V1.carts.cartId.gift_message.post({
  "cartId": 0
}, context)

Input

Output

  • output boolean

V1.carts.cartId.gift_message.itemId.get

Return the gift message for a specified item in a specified shopping cart.

magento.V1.carts.cartId.gift_message.itemId.get({
  "cartId": 0,
  "itemId": 0
}, context)

Input

  • input object
    • cartId required integer: The shopping cart ID.
    • itemId required integer: The item ID.

Output

V1.carts.cartId.gift_message.itemId.post

Set the gift message for a specified item in a specified shopping cart.

magento.V1.carts.cartId.gift_message.itemId.post({
  "cartId": 0,
  "itemId": 0
}, context)

Input

Output

  • output boolean

giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut

magento.giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut({
  "cartId": 0
}, context)

Input

Output

  • output boolean

V1.carts.cartId.giftCards.giftCardCode.delete

Remove GiftCard Account entity

magento.V1.carts.cartId.giftCards.giftCardCode.delete({
  "cartId": 0,
  "giftCardCode": ""
}, context)

Input

  • input object
    • cartId required integer
    • giftCardCode required string

Output

  • output boolean

V1.carts.cartId.items.get

Lists items that are assigned to a specified cart.

magento.V1.carts.cartId.items.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.

Output

V1.carts.cartId.items.itemId.delete

Removes the specified item from the specified cart.

magento.V1.carts.cartId.items.itemId.delete({
  "cartId": 0,
  "itemId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.
    • itemId required integer: The item ID of the item to be removed.

Output

  • output boolean

V1.carts.cartId.items.itemId.put

Add/update the specified cart item.

magento.V1.carts.cartId.items.itemId.put({
  "cartId": "",
  "itemId": ""
}, context)

Input

Output

V1.carts.cartId.order.put

Places an order for a specified cart.

magento.V1.carts.cartId.order.put({
  "cartId": 0
}, context)

Input

Output

  • output integer: Order ID.

V1.carts.cartId.payment_methods.get

Lists available payment methods for a specified shopping cart. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#PaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.

magento.V1.carts.cartId.payment_methods.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.

Output

V1.carts.cartId.selected_payment_method.get

Returns the payment method for a specified shopping cart.

magento.V1.carts.cartId.selected_payment_method.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.

Output

V1.carts.cartId.selected_payment_method.put

Adds a specified payment method to a specified shopping cart.

magento.V1.carts.cartId.selected_payment_method.put({
  "cartId": 0
}, context)

Input

Output

  • output string: redirect url or error message.

V1.carts.cartId.shipping_information.post

magento.V1.carts.cartId.shipping_information.post({
  "cartId": 0
}, context)

Input

Output

V1.carts.cartId.shipping_methods.get

Lists applicable shipping methods for a specified quote.

magento.V1.carts.cartId.shipping_methods.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The shopping cart ID.

Output

V1.carts.cartId.totals.get

Returns quote totals data for a specified cart.

magento.V1.carts.cartId.totals.get({
  "cartId": 0
}, context)

Input

  • input object
    • cartId required integer: The cart ID.

Output

V1.carts.cartId.totals_information.post

Calculate quote totals based on address and shipping method.

magento.V1.carts.cartId.totals_information.post({
  "cartId": 0
}, context)

Input

Output

giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet

Return GiftCard Account cards

magento.giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet({
  "quoteId": 0
}, context)

Input

  • input object
    • quoteId required integer

Output

V1.carts.quoteId.items.post

Add/update the specified cart item.

magento.V1.carts.quoteId.items.post({
  "quoteId": ""
}, context)

Input

Output

catalogCategoryManagementV1GetTreeGet

Retrieve list of categories

magento.catalogCategoryManagementV1GetTreeGet({}, context)

Input

  • input object
    • rootCategoryId integer
    • depth integer

Output

catalogCategoryRepositoryV1SavePost

Create category service

magento.catalogCategoryRepositoryV1SavePost({}, context)

Input

Output

catalogCategoryAttributeRepositoryV1GetListGet

Retrieve all attributes for entity type

magento.catalogCategoryAttributeRepositoryV1GetListGet({}, context)

Input

Output

catalogCategoryAttributeRepositoryV1GetGet

Retrieve specific attribute

magento.catalogCategoryAttributeRepositoryV1GetGet({
  "attributeCode": ""
}, context)

Input

  • input object
    • attributeCode required string

Output

catalogCategoryAttributeOptionManagementV1GetItemsGet

Retrieve list of attribute options

magento.catalogCategoryAttributeOptionManagementV1GetItemsGet({
  "attributeCode": ""
}, context)

Input

  • input object
    • attributeCode required string

Output

catalogCategoryRepositoryV1DeleteByIdentifierDelete

Delete category by identifier

magento.catalogCategoryRepositoryV1DeleteByIdentifierDelete({
  "categoryId": 0
}, context)

Input

  • input object
    • categoryId required integer

Output

  • output boolean: Will returned True if deleted

catalogCategoryRepositoryV1GetGet

Get info about category by category id

magento.catalogCategoryRepositoryV1GetGet({
  "categoryId": 0
}, context)

Input

  • input object
    • categoryId required integer
    • storeId integer

Output

catalogCategoryManagementV1MovePut

Move category

magento.catalogCategoryManagementV1MovePut({
  "categoryId": 0
}, context)

Input

  • input object
    • categoryId required integer
    • $body object
      • afterId integer
      • parentId required integer

Output

  • output boolean

catalogCategoryLinkManagementV1GetAssignedProductsGet

Get products assigned to category

magento.catalogCategoryLinkManagementV1GetAssignedProductsGet({
  "categoryId": 0
}, context)

Input

  • input object
    • categoryId required integer

Output

catalogCategoryLinkRepositoryV1SavePost

Assign a product to the required category

magento.catalogCategoryLinkRepositoryV1SavePost({
  "categoryId": ""
}, context)

Input

Output

  • output boolean: will returned True if assigned

catalogCategoryLinkRepositoryV1SavePut

Assign a product to the required category

magento.catalogCategoryLinkRepositoryV1SavePut({
  "categoryId": ""
}, context)

Input

Output

  • output boolean: will returned True if assigned

catalogCategoryLinkRepositoryV1DeleteByIdsDelete

Remove the product assignment from the category by category id and sku

magento.catalogCategoryLinkRepositoryV1DeleteByIdsDelete({
  "categoryId": "",
  "sku": ""
}, context)

Input

  • input object
    • categoryId required string
    • sku required string

Output

  • output boolean: will returned True if products successfully deleted

catalogCategoryRepositoryV1SavePut

Create category service

magento.catalogCategoryRepositoryV1SavePut({
  "id": ""
}, context)

Input

Output

cmsBlockRepositoryV1SavePost

Save block.

magento.cmsBlockRepositoryV1SavePost({}, context)

Input

Output

cmsBlockRepositoryV1GetListGet

Retrieve blocks matching the specified criteria.

magento.cmsBlockRepositoryV1GetListGet({}, context)

Input

Output

cmsBlockRepositoryV1DeleteByIdDelete

Delete block by ID.

magento.cmsBlockRepositoryV1DeleteByIdDelete({
  "blockId": 0
}, context)

Input

  • input object
    • blockId required integer

Output

  • output boolean: true on success

cmsBlockRepositoryV1GetByIdGet

Retrieve block.

magento.cmsBlockRepositoryV1GetByIdGet({
  "blockId": 0
}, context)

Input

  • input object
    • blockId required integer

Output

cmsBlockRepositoryV1SavePut

Save block.

magento.cmsBlockRepositoryV1SavePut({
  "id": ""
}, context)

Input

Output

cmsPageRepositoryV1SavePost

Save page.

magento.cmsPageRepositoryV1SavePost({}, context)

Input

Output

cmsPageRepositoryV1GetListGet

Retrieve pages matching the specified criteria.

magento.cmsPageRepositoryV1GetListGet({}, context)

Input

Output

cmsPageRepositoryV1SavePut

Save page.

magento.cmsPageRepositoryV1SavePut({
  "id": ""
}, context)

Input

Output

cmsPageRepositoryV1DeleteByIdDelete

Delete page by ID.

magento.cmsPageRepositoryV1DeleteByIdDelete({
  "pageId": 0
}, context)

Input

  • input object
    • pageId required integer

Output

  • output boolean: true on success

cmsPageRepositoryV1GetByIdGet

Retrieve page.

magento.cmsPageRepositoryV1GetByIdGet({
  "pageId": 0
}, context)

Input

  • input object
    • pageId required integer

Output

configurableProductConfigurableProductManagementV1GenerateVariationPut

Generate variation based on same product

magento.configurableProductConfigurableProductManagementV1GenerateVariationPut({}, context)

Input

Output

configurableProductLinkManagementV1AddChildPost

magento.configurableProductLinkManagementV1AddChildPost({
  "sku": ""
}, context)

Input

  • input object
    • sku required string
    • $body object
      • childSku required string

Output

  • output boolean

configurableProductLinkManagementV1GetChildrenGet

Get all children for Configurable product

magento.configurableProductLinkManagementV1GetChildrenGet({
  "sku": ""
}, context)

Input

  • input object
    • sku required string

Output

configurableProductLinkManagementV1RemoveChildDelete

Remove configurable product option

magento.configurableProductLinkManagementV1RemoveChildDelete({
  "sku": "",
  "childSku": ""
}, context)

Input

  • input object
    • sku required string
    • childSku required string

Output

  • output boolean

configurableProductOptionRepositoryV1SavePost

Save option

magento.configurableProductOptionRepositoryV1SavePost({
  "sku": ""
}, context)

Input

Output

  • output integer

configurableProductOptionRepositoryV1GetListGet

Get all options for configurable product

magento.configurableProductOptionRepositoryV1GetListGet({
  "sku": ""
}, context)

Input

  • input object
    • sku required string

Output

configurableProductOptionRepositoryV1DeleteByIdDelete

Remove option from configurable product

magento.configurableProductOptionRepositoryV1DeleteByIdDelete({
  "sku": "",
  "id": 0
}, context)

Input

  • input object
    • sku required string
    • id required integer

Output

  • output boolean

configurableProductOptionRepositoryV1GetGet

Get option for configurable product

magento.configurableProductOptionRepositoryV1GetGet({
  "sku": "",
  "id": 0
}, context)

Input

  • input object
    • sku required string
    • id required integer

Output

configurableProductOptionRepositoryV1SavePut

Save option

magento.configurableProductOptionRepositoryV1SavePut({
  "sku": "",
  "id": ""
}, context)

Input

Output

  • output integer

salesRuleCouponRepositoryV1SavePost

Save a coupon.

magento.salesRuleCouponRepositoryV1SavePost({}, context)

Input

Output

salesRuleCouponManagementV1DeleteByCodesPost

Delete coupon by coupon codes.

magento.salesRuleCouponManagementV1DeleteByCodesPost({}, context)

Input

  • input object
    • $body object
      • codes required array
        • items string
      • ignoreInvalidCoupons boolean

Output

salesRuleCouponManagementV1DeleteByIdsPost

Delete coupon by coupon ids.

magento.salesRuleCouponManagementV1DeleteByIdsPost({}, context)

Input

  • input object
    • $body object
      • ids required array
        • items integer
      • ignoreInvalidCoupons boolean

Output

salesRuleCouponManagementV1GeneratePost

Generate coupon for a rule

magento.salesRuleCouponManagementV1GeneratePost({}, context)

Input

Output

  • output array
    • items string

salesRuleCouponRepositoryV1GetListGet

Retrieve a coupon using the specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CouponRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

magento.salesRuleCouponRepositoryV1GetListGet({}, context)

Input

Output

salesRuleCouponRepositoryV1DeleteByIdDelete

Delete coupon by coupon id.

magento.salesRuleCouponRepositoryV1DeleteByIdDelete({
  "couponId": 0
}, context)

Input

  • input object
    • couponId required integer

Output

  • output boolean: true on success

salesRuleCouponRepositoryV1GetByIdGet

Get coupon by coupon id.

magento.salesRuleCouponRepositoryV1GetByIdGet({
  "couponId": 0
}, context)

Input

  • input object
    • couponId required integer

Output

salesRuleCouponRepositoryV1SavePut

Save a coupon.

magento.salesRuleCouponRepositoryV1SavePut({
  "couponId": ""
}, context)

Input

Output

salesCreditmemoRepositoryV1SavePost

Performs persist operations for a specified credit memo.

magento.salesCreditmemoRepositoryV1SavePost({}, context)

Input

Output

salesCreditmemoManagementV1RefundPost

Prepare creditmemo to refund and save it.

magento.salesCreditmemoManagementV1RefundPost({}, context)

Input

Output

salesCreditmemoRepositoryV1GetGet

Loads a specified credit memo.

magento.salesCreditmemoRepositoryV1GetGet({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The credit memo ID.

Output

salesCreditmemoManagementV1CancelPut

Cancels a specified credit memo.

magento.salesCreditmemoManagementV1CancelPut({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The credit memo ID.

Output

  • output boolean

salesCreditmemoManagementV1GetCommentsListGet

Lists comments for a specified credit memo.

magento.salesCreditmemoManagementV1GetCommentsListGet({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The credit memo ID.

Output

salesCreditmemoCommentRepositoryV1SavePost

Performs persist operations for a specified entity.

magento.salesCreditmemoCommentRepositoryV1SavePost({
  "id": ""
}, context)

Input

Output

salesCreditmemoManagementV1NotifyPost

Emails a user a specified credit memo.

magento.salesCreditmemoManagementV1NotifyPost({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The credit memo ID.

Output

  • output boolean

salesCreditmemoRepositoryV1GetListGet

Lists credit memos that match specified search criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CreditmemoRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

magento.salesCreditmemoRepositoryV1GetListGet({}, context)

Input

Output

customerGroupRepositoryV1SavePost

Save customer group.

magento.customerGroupRepositoryV1SavePost({}, context)

Input

Output

V1.customerGroups.default.get

Get default customer group.

magento.V1.customerGroups.default.get({}, context)

Input

  • input object
    • storeId integer

Output

V1.customerGroups.default.storeId.get

Get default customer group.

magento.V1.customerGroups.default.storeId.get({
  "storeId": 0
}, context)

Input

  • input object
    • storeId required integer

Output

customerGroupRepositoryV1GetListGet

Retrieve customer groups. The list of groups can be filtered to exclude the NOT_LOGGED_IN group using the first parameter and/or it can be filtered by tax class. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#GroupRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

magento.customerGroupRepositoryV1GetListGet({}, context)

Input

Output

customerGroupRepositoryV1DeleteByIdDelete

Delete customer group by ID.

magento.customerGroupRepositoryV1DeleteByIdDelete({
  "id": 0
}, context)

Input

  • input object
    • id required integer

Output

  • output boolean: true on success

customerGroupRepositoryV1GetByIdGet

Get customer group by group ID.

magento.customerGroupRepositoryV1GetByIdGet({
  "id": 0
}, context)

Input

  • input object
    • id required integer

Output

customerGroupRepositoryV1SavePut

Save customer group.

magento.customerGroupRepositoryV1SavePut({
  "id": ""
}, context)

Input

Output

customerGroupManagementV1IsReadonlyGet

Check if customer group can be deleted.

magento.customerGroupManagementV1IsReadonlyGet({
  "id": 0
}, context)

Input

  • input object
    • id required integer

Output

  • output boolean

customerAccountManagementV1CreateAccountPost

Create customer account. Perform necessary business operations like sending email.

magento.customerAccountManagementV1CreateAccountPost({}, context)

Input

Output

customerAddressRepositoryV1GetByIdGet

Retrieve customer address.

magento.customerAddressRepositoryV1GetByIdGet({
  "addressId": 0
}, context)

Input

  • input object
    • addressId required integer

Output

customerAccountManagementV1ResendConfirmationPost

Resend confirmation email.

magento.customerAccountManagementV1ResendConfirmationPost({}, context)

Input

  • input object
    • $body object
      • email required string
      • redirectUrl string
      • websiteId required integer

Output

  • output boolean: true on success

customerAccountManagementV1IsEmailAvailablePost

Check if given email is associated with a customer account in given website.

magento.customerAccountManagementV1IsEmailAvailablePost({}, context)

Input

  • input object
    • $body object
      • customerEmail required string
      • websiteId integer: If not set, will use the current websiteId

Output

  • output boolean

V1.customers.me.get

Get customer by customer ID.

magento.V1.customers.me.get(null, context)

Input

This action has no parameters

Output

V1.customers.me.put

Create or update a customer.

magento.V1.customers.me.put({}, context)

Input

Output

customerAccountManagementV1ActivateByIdPut

Activate a customer account using a key that was sent in a confirmation email.

magento.customerAccountManagementV1ActivateByIdPut({}, context)

Input

  • input object
    • $body object
      • confirmationKey required string

Output

V1.customers.me.billingAddress.get

Retrieve default billing address for the given customerId.

magento.V1.customers.me.billingAddress.get(null, context)

Input

This action has no parameters

Output

customerAccountManagementV1ChangePasswordByIdPut

Change customer password.

magento.customerAccountManagementV1ChangePasswordByIdPut({}, context)

Input

  • input object
    • $body object
      • currentPassword required string
      • newPassword required string

Output

  • output boolean: true on success

V1.customers.me.shippingAddress.get

Retrieve default shipping address for the given customerId.

magento.V1.customers.me.shippingAddress.get(null, context)

Input

This action has no parameters

Output

customerAccountManagementV1InitiatePasswordResetPut

Send an email to the customer with a password reset link.

magento.customerAccountManagementV1InitiatePasswordResetPut({}, context)

Input

  • input object
    • $body object
      • email required string
      • template required string
      • websiteId integer

Output

  • output boolean: true on success

customerCustomerRepositoryV1GetListGet

Retrieve customers which match a specified criteria. This call returns an array of objects, but detailed information about each object’s attributes might not be included. See http://devdocs.magento.com/codelinks/attributes.html#CustomerRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

magento.customerCustomerRepositoryV1GetListGet({}, context)

Input

Output

customerAccountManagementV1ValidatePut

Validate customer data.

magento.customerAccountManagementV1ValidatePut({}, context)

Input

Output

customerCustomerRepositoryV1DeleteByIdDelete

Delete customer by ID.

magento.customerCustomerRepositoryV1DeleteByIdDelete({
  "customerId": 0
}, context)

Input

  • input object
    • customerId required integer

Output

  • output boolean: true on success

V1.customers.customerId.get

Get customer by customer ID.

magento.V1.customers.customerId.get({
  "customerId": 0
}, context)

Input

  • input object
    • customerId required integer

Output

V1.customers.customerId.billingAddress.get

Retrieve default billing address for the given customerId.

magento.V1.customers.customerId.billingAddress.get({
  "customerId": 0
}, context)

Input

  • input object
    • customerId required integer

Output

V1.customers.customerId.carts.post

Creates an empty cart and quote for a specified customer.

magento.V1.customers.customerId.carts.post({
  "customerId": 0
}, context)

Input

  • input object
    • customerId required integer: The customer ID.

Output

  • output integer: Cart ID.

customerAccountManagementV1GetConfirmationStatusGet

Gets the account confirmation status.

magento.customerAccountManagementV1GetConfirmationStatusGet({
  "customerId": 0
}, context)

Input

  • input object
    • customerId required integer

Output

  • output string

customerAccountManagementV1ValidateResetPasswordLinkTokenGet

Check if password reset token is valid.

magento.customerAccountManagementV1ValidateResetPasswordLinkTokenGet({
  "customerId": 0,
  "resetPasswordLinkToken": ""
}, context)

Input

  • input object
    • customerId required integer
    • resetPasswordLinkToken required string

Output

  • output boolean: True if the token is valid

customerAccountManagementV1IsReadonlyGet

Check if customer can be deleted.

magento.customerAccountManagementV1IsReadonlyGet({
  "customerId": 0
}, context)

Input

  • input object
    • customerId required integer

Output

  • output boolean

V1.customers.customerId.shippingAddress.get

Retrieve default shipping address for the given customerId.

magento.V1.customers.customerId.shippingAddress.get({
  "customerId": 0
}, context)

Input

  • input object
    • customerId required integer

Output

customerAccountManagementV1ActivatePut

Activate a customer account using a key that was sent in a confirmation email.

magento.customerAccountManagementV1ActivatePut({
  "email": ""
}, cont
datafire
@infinitebrahmanuniverse/nolb-_datafire_m@everything-registry/sub-chunk-222@zalastax/nolb-_datafire_m
6.0.0

5 years ago

5.0.1

7 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

0.0.3

9 years ago

0.0.1

9 years ago