2.0.2 • Published 8 years ago

@datafire/t213_vg v2.0.2

Weekly downloads
2
License
MIT
Repository
github
Last release
8 years ago

@datafire/t213_vg

Client library for Magento Enterprise

Installation and Usage

npm install --save datafire @datafire/t213_vg
let datafire = require('datafire');
let t213_vg = require('@datafire/t213_vg').actions;
let context = new datafire.Context();

t213_vg.salesTransactionRepositoryV1GetListGet({}, context).then(data => {
  console.log(data);
})

Description

Magento Commerce is the leading provider of open omnichannel innovation.

Actions

customerAddressRepositoryV1DeleteByIdDelete

Delete customer address by ID.

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

Parameters

  • addressId (integer) required

customerCustomerMetadataV1GetAllAttributesMetadataGet

Get all attribute metadata.

t213_vg.customerCustomerMetadataV1GetAllAttributesMetadataGet(null, context)

customerCustomerMetadataV1GetAttributeMetadataGet

Retrieve attribute metadata.

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

Parameters

  • attributeCode (string) required

customerCustomerMetadataV1GetCustomAttributesMetadataGet

Get custom attributes metadata for the given data interface.

t213_vg.customerCustomerMetadataV1GetCustomAttributesMetadataGet({}, context)

Parameters

  • dataInterfaceName (string)

customerCustomerMetadataV1GetAttributesGet

Retrieve all attributes filtered by form code

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

Parameters

  • formCode (string) required

customerAddressMetadataV1GetAllAttributesMetadataGet

Get all attribute metadata.

t213_vg.customerAddressMetadataV1GetAllAttributesMetadataGet(null, context)

customerAddressMetadataV1GetAttributeMetadataGet

Retrieve attribute metadata.

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

Parameters

  • attributeCode (string) required

customerAddressMetadataV1GetCustomAttributesMetadataGet

Get custom attributes metadata for the given data interface.

t213_vg.customerAddressMetadataV1GetCustomAttributesMetadataGet({}, context)

Parameters

  • dataInterfaceName (string)

customerAddressMetadataV1GetAttributesGet

Retrieve all attributes filtered by form code

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

Parameters

  • formCode (string) required

bundleProductOptionManagementV1SavePost

Add new option for bundle product

t213_vg.bundleProductOptionManagementV1SavePost({}, context)

Parameters

  • $body (object)

bundleProductOptionTypeListV1GetItemsGet

Get all types for options for bundle products

t213_vg.bundleProductOptionTypeListV1GetItemsGet(null, context)

bundleProductOptionManagementV1SavePut

Add new option for bundle product

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

Parameters

  • optionId (string) required
  • $body (object)

bundleProductLinkManagementV1GetChildrenGet

Get all children for Bundle product

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

Parameters

  • productSku (string) required
  • optionId (integer)

bundleProductLinkManagementV1SaveChildPut

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

Parameters

  • sku (string) required
  • id (string) required
  • $body (object)

bundleProductLinkManagementV1AddChildByProductSkuPost

Add child product to specified Bundle option by product sku

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

Parameters

  • sku (string) required
  • optionId (integer) required
  • $body (object)

bundleProductOptionRepositoryV1GetListGet

Get all options for bundle product

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

Parameters

  • sku (string) required

bundleProductOptionRepositoryV1DeleteByIdDelete

Remove bundle option

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

Parameters

  • sku (string) required
  • optionId (integer) required

bundleProductOptionRepositoryV1GetGet

Get option for bundle product

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

Parameters

  • sku (string) required
  • optionId (integer) required

bundleProductLinkManagementV1RemoveChildDelete

Remove product from Bundle product option

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

Parameters

  • sku (string) required
  • optionId (integer) required
  • childSku (string) required

quoteCartManagementV1CreateEmptyCartPost

Creates an empty cart and quote for a guest.

t213_vg.quoteCartManagementV1CreateEmptyCartPost(null, context)

giftCardAccountGuestGiftCardAccountManagementV1CheckGiftCardGet

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

Parameters

  • cartId (string) required
  • giftCardCode (string) required

giftCardAccountGuestGiftCardAccountManagementV1AddGiftCardPost

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

Parameters

  • cartId (string) required
  • $body (object)

giftCardAccountGuestGiftCardAccountManagementV1DeleteByQuoteIdDelete

Remove GiftCard Account entity

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

Parameters

  • cartId (string) required
  • giftCardCode (string) required

checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet

Lists active checkout agreements.

t213_vg.checkoutAgreementsCheckoutAgreementsRepositoryV1GetListGet(null, context)

quoteCartManagementV1GetCartForCustomerGet

Returns information for the cart for a specified customer.

t213_vg.quoteCartManagementV1GetCartForCustomerGet(null, context)

V1.carts.mine.post

Creates an empty cart and quote for a specified customer.

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

quoteCartRepositoryV1SavePut

Save quote

t213_vg.quoteCartRepositoryV1SavePut({}, context)

Parameters

  • $body (object)

customerBalanceBalanceManagementV1ApplyPost

Apply store credit

t213_vg.customerBalanceBalanceManagementV1ApplyPost(null, context)

V1.carts.mine.billing_address.get

Returns the billing address for a specified quote.

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

V1.carts.mine.billing_address.post

Assigns a specified billing address to a specified cart.

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

Parameters

  • $body (object)

giftCardAccountGiftCardAccountManagementV1CheckGiftCardGet

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

Parameters

  • giftCardCode (string) required

quoteCartTotalManagementV1CollectTotalsPut

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

t213_vg.quoteCartTotalManagementV1CollectTotalsPut({}, context)

Parameters

  • $body (object)

V1.carts.mine.coupons.delete

Deletes a coupon from a specified cart.

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

V1.carts.mine.coupons.get

Returns information for a coupon in a specified cart.

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

V1.carts.mine.coupons.couponCode.put

Adds a coupon by code to a specified cart.

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

Parameters

  • couponCode (string) required - The coupon code data.

V1.carts.mine.estimate_shipping_methods.post

Estimate shipping by address and return list of available shipping methods

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

Parameters

  • $body (object)

V1.carts.mine.estimate_shipping_methods_by_address_id.post

Estimate shipping

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

Parameters

  • $body (object)

V1.carts.mine.gift_message.get

Return the gift message for a specified order.

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

V1.carts.mine.gift_message.post

Set the gift message for an entire order.

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

Parameters

  • $body (object)

V1.carts.mine.gift_message.itemId.get

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

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

Parameters

  • itemId (integer) required - The item ID.

V1.carts.mine.gift_message.itemId.post

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

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

Parameters

  • itemId (integer) required - The item ID.
  • $body (object)

giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost

t213_vg.giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPost({}, context)

Parameters

  • $body (object)

V1.carts.mine.giftCards.giftCardCode.delete

Remove GiftCard Account entity

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

Parameters

  • giftCardCode (string) required

V1.carts.mine.items.get

Lists items that are assigned to a specified cart.

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

V1.carts.mine.items.post

Add/update the specified cart item.

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

Parameters

  • $body (object)

V1.carts.mine.items.itemId.delete

Removes the specified item from the specified cart.

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

Parameters

  • itemId (integer) required - The item ID of the item to be removed.

V1.carts.mine.items.itemId.put

Add/update the specified cart item.

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

Parameters

  • itemId (string) required
  • $body (object)

V1.carts.mine.order.put

Places an order for a specified cart.

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

Parameters

  • $body (object)

checkoutPaymentInformationManagementV1GetPaymentInformationGet

Get payment information

t213_vg.checkoutPaymentInformationManagementV1GetPaymentInformationGet(null, context)

checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost

Set payment information and place order for a specified cart.

t213_vg.checkoutPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost({}, context)

Parameters

  • $body (object)

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.

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

V1.carts.mine.selected_payment_method.get

Returns the payment method for a specified shopping cart.

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

V1.carts.mine.selected_payment_method.put

Adds a specified payment method to a specified shopping cart.

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

Parameters

  • $body (object)

checkoutPaymentInformationManagementV1SavePaymentInformationPost

Set payment information for a specified cart.

t213_vg.checkoutPaymentInformationManagementV1SavePaymentInformationPost({}, context)

Parameters

  • $body (object)

V1.carts.mine.shipping_information.post

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

Parameters

  • $body (object)

V1.carts.mine.shipping_methods.get

Lists applicable shipping methods for a specified quote.

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

V1.carts.mine.totals.get

Returns quote totals data for a specified cart.

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

V1.carts.mine.totals_information.post

Calculate quote totals based on address and shipping method.

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

Parameters

  • $body (object)

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.

t213_vg.quoteCartRepositoryV1GetListGet({}, context)

Parameters

quoteCartRepositoryV1GetGet

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

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

Parameters

  • cartId (integer) required

quoteCartManagementV1AssignCustomerPut

Assigns a specified customer to a specified shopping cart.

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

Parameters

  • cartId (integer) required - The cart ID.
  • $body (object)

V1.carts.cartId.billing_address.get

Returns the billing address for a specified quote.

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

Parameters

  • cartId (integer) required - The cart ID.

V1.carts.cartId.billing_address.post

Assigns a specified billing address to a specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.
  • $body (object)

V1.carts.cartId.coupons.delete

Deletes a coupon from a specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.

V1.carts.cartId.coupons.get

Returns information for a coupon in a specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.

V1.carts.cartId.coupons.couponCode.put

Adds a coupon by code to a specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.
  • couponCode (string) required - The coupon code data.

V1.carts.cartId.estimate_shipping_methods.post

Estimate shipping by address and return list of available shipping methods

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

Parameters

  • cartId (string) required
  • $body (object)

V1.carts.cartId.estimate_shipping_methods_by_address_id.post

Estimate shipping

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

Parameters

  • cartId (integer) required - The shopping cart ID.
  • $body (object)

V1.carts.cartId.gift_message.get

Return the gift message for a specified order.

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

Parameters

  • cartId (integer) required - The shopping cart ID.

V1.carts.cartId.gift_message.post

Set the gift message for an entire order.

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

Parameters

  • cartId (integer) required - The cart ID.
  • $body (object)

V1.carts.cartId.gift_message.itemId.get

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

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

Parameters

  • cartId (integer) required - The shopping cart ID.
  • itemId (integer) required - The item ID.

V1.carts.cartId.gift_message.itemId.post

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

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

Parameters

  • cartId (integer) required - The cart ID.
  • itemId (integer) required - The item ID.
  • $body (object)

giftCardAccountGiftCardAccountManagementV1SaveByQuoteIdPut

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

Parameters

  • cartId (integer) required
  • $body (object)

V1.carts.cartId.giftCards.giftCardCode.delete

Remove GiftCard Account entity

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

Parameters

  • cartId (integer) required
  • giftCardCode (string) required

V1.carts.cartId.items.get

Lists items that are assigned to a specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.

V1.carts.cartId.items.itemId.delete

Removes the specified item from the specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.
  • itemId (integer) required - The item ID of the item to be removed.

V1.carts.cartId.items.itemId.put

Add/update the specified cart item.

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

Parameters

  • cartId (string) required
  • itemId (string) required
  • $body (object)

V1.carts.cartId.order.put

Places an order for a specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.
  • $body (object)

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.

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

Parameters

  • cartId (integer) required - The cart ID.

V1.carts.cartId.selected_payment_method.get

Returns the payment method for a specified shopping cart.

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

Parameters

  • cartId (integer) required - The cart ID.

V1.carts.cartId.selected_payment_method.put

Adds a specified payment method to a specified shopping cart.

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

Parameters

  • cartId (integer) required - The cart ID.
  • $body (object)

V1.carts.cartId.shipping_information.post

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

Parameters

  • cartId (integer) required
  • $body (object)

V1.carts.cartId.shipping_methods.get

Lists applicable shipping methods for a specified quote.

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

Parameters

  • cartId (integer) required - The shopping cart ID.

V1.carts.cartId.totals.get

Returns quote totals data for a specified cart.

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

Parameters

  • cartId (integer) required - The cart ID.

V1.carts.cartId.totals_information.post

Calculate quote totals based on address and shipping method.

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

Parameters

  • cartId (integer) required
  • $body (object)

giftCardAccountGiftCardAccountManagementV1GetListByQuoteIdGet

Return GiftCard Account cards

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

Parameters

  • quoteId (integer) required

V1.carts.quoteId.items.post

Add/update the specified cart item.

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

Parameters

  • quoteId (string) required
  • $body (object)

catalogCategoryManagementV1GetTreeGet

Retrieve list of categories

t213_vg.catalogCategoryManagementV1GetTreeGet({}, context)

Parameters

  • rootCategoryId (integer)
  • depth (integer)

catalogCategoryRepositoryV1SavePost

Create category service

t213_vg.catalogCategoryRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

catalogCategoryAttributeRepositoryV1GetListGet

Retrieve all attributes for entity type

t213_vg.catalogCategoryAttributeRepositoryV1GetListGet({}, context)

Parameters

catalogCategoryAttributeRepositoryV1GetGet

Retrieve specific attribute

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

Parameters

  • attributeCode (string) required

catalogCategoryAttributeOptionManagementV1GetItemsGet

Retrieve list of attribute options

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

Parameters

  • attributeCode (string) required

catalogCategoryRepositoryV1DeleteByIdentifierDelete

Delete category by identifier

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

Parameters

  • categoryId (integer) required

catalogCategoryRepositoryV1GetGet

Get info about category by category id

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

Parameters

  • categoryId (integer) required
  • storeId (integer)

catalogCategoryManagementV1MovePut

Move category

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

Parameters

  • categoryId (integer) required
  • $body (object)

catalogCategoryLinkManagementV1GetAssignedProductsGet

Get products assigned to category

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

Parameters

  • categoryId (integer) required

catalogCategoryLinkRepositoryV1SavePost

Assign a product to the required category

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

Parameters

  • categoryId (string) required
  • $body (object)

catalogCategoryLinkRepositoryV1SavePut

Assign a product to the required category

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

Parameters

  • categoryId (string) required
  • $body (object)

catalogCategoryLinkRepositoryV1DeleteByIdsDelete

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

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

Parameters

  • categoryId (string) required
  • sku (string) required

catalogCategoryRepositoryV1SavePut

Create category service

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

Parameters

  • id (string) required
  • $body (object)

cmsBlockRepositoryV1SavePost

Save block.

t213_vg.cmsBlockRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

cmsBlockRepositoryV1GetListGet

Retrieve blocks matching the specified criteria.

t213_vg.cmsBlockRepositoryV1GetListGet({}, context)

Parameters

cmsBlockRepositoryV1DeleteByIdDelete

Delete block by ID.

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

Parameters

  • blockId (integer) required

cmsBlockRepositoryV1GetByIdGet

Retrieve block.

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

Parameters

  • blockId (integer) required

cmsBlockRepositoryV1SavePut

Save block.

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

Parameters

  • id (string) required
  • $body (object)

cmsPageRepositoryV1SavePost

Save page.

t213_vg.cmsPageRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

cmsPageRepositoryV1GetListGet

Retrieve pages matching the specified criteria.

t213_vg.cmsPageRepositoryV1GetListGet({}, context)

Parameters

cmsPageRepositoryV1SavePut

Save page.

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

Parameters

  • id (string) required
  • $body (object)

cmsPageRepositoryV1DeleteByIdDelete

Delete page by ID.

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

Parameters

  • pageId (integer) required

cmsPageRepositoryV1GetByIdGet

Retrieve page.

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

Parameters

  • pageId (integer) required

configurableProductConfigurableProductManagementV1GenerateVariationPut

Generate variation based on same product

t213_vg.configurableProductConfigurableProductManagementV1GenerateVariationPut({}, context)

Parameters

  • $body (object)

configurableProductLinkManagementV1AddChildPost

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

Parameters

  • sku (string) required
  • $body (object)

configurableProductLinkManagementV1GetChildrenGet

Get all children for Configurable product

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

Parameters

  • sku (string) required

configurableProductLinkManagementV1RemoveChildDelete

Remove configurable product option

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

Parameters

  • sku (string) required
  • childSku (string) required

configurableProductOptionRepositoryV1SavePost

Save option

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

Parameters

  • sku (string) required
  • $body (object)

configurableProductOptionRepositoryV1GetListGet

Get all options for configurable product

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

Parameters

  • sku (string) required

configurableProductOptionRepositoryV1DeleteByIdDelete

Remove option from configurable product

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

Parameters

  • sku (string) required
  • id (integer) required

configurableProductOptionRepositoryV1GetGet

Get option for configurable product

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

Parameters

  • sku (string) required
  • id (integer) required

configurableProductOptionRepositoryV1SavePut

Save option

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

Parameters

  • sku (string) required
  • id (string) required
  • $body (object)

salesRuleCouponRepositoryV1SavePost

Save a coupon.

t213_vg.salesRuleCouponRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

salesRuleCouponManagementV1DeleteByCodesPost

Delete coupon by coupon codes.

t213_vg.salesRuleCouponManagementV1DeleteByCodesPost({}, context)

Parameters

  • $body (object)

salesRuleCouponManagementV1DeleteByIdsPost

Delete coupon by coupon ids.

t213_vg.salesRuleCouponManagementV1DeleteByIdsPost({}, context)

Parameters

  • $body (object)

salesRuleCouponManagementV1GeneratePost

Generate coupon for a rule

t213_vg.salesRuleCouponManagementV1GeneratePost({}, context)

Parameters

  • $body (object)

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.

t213_vg.salesRuleCouponRepositoryV1GetListGet({}, context)

Parameters

salesRuleCouponRepositoryV1DeleteByIdDelete

Delete coupon by coupon id.

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

Parameters

  • couponId (integer) required

salesRuleCouponRepositoryV1GetByIdGet

Get coupon by coupon id.

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

Parameters

  • couponId (integer) required

salesRuleCouponRepositoryV1SavePut

Save a coupon.

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

Parameters

  • couponId (string) required
  • $body (object)

salesCreditmemoRepositoryV1SavePost

Performs persist operations for a specified credit memo.

t213_vg.salesCreditmemoRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

salesCreditmemoManagementV1RefundPost

Prepare creditmemo to refund and save it.

t213_vg.salesCreditmemoManagementV1RefundPost({}, context)

Parameters

  • $body (object)

salesCreditmemoRepositoryV1GetGet

Loads a specified credit memo.

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

Parameters

  • id (integer) required - The credit memo ID.

salesCreditmemoManagementV1CancelPut

Cancels a specified credit memo.

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

Parameters

  • id (integer) required - The credit memo ID.

salesCreditmemoManagementV1GetCommentsListGet

Lists comments for a specified credit memo.

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

Parameters

  • id (integer) required - The credit memo ID.

salesCreditmemoCommentRepositoryV1SavePost

Performs persist operations for a specified entity.

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

Parameters

  • id (string) required
  • $body (object)

salesCreditmemoManagementV1NotifyPost

Emails a user a specified credit memo.

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

Parameters

  • id (integer) required - The credit memo ID.

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.

t213_vg.salesCreditmemoRepositoryV1GetListGet({}, context)

Parameters

customerGroupRepositoryV1SavePost

Save customer group.

t213_vg.customerGroupRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

V1.customerGroups.default.get

Get default customer group.

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

Parameters

  • storeId (integer)

V1.customerGroups.default.storeId.get

Get default customer group.

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

Parameters

  • storeId (integer) required

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.

t213_vg.customerGroupRepositoryV1GetListGet({}, context)

Parameters

customerGroupRepositoryV1DeleteByIdDelete

Delete customer group by ID.

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

Parameters

  • id (integer) required

customerGroupRepositoryV1GetByIdGet

Get customer group by group ID.

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

Parameters

  • id (integer) required

customerGroupRepositoryV1SavePut

Save customer group.

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

Parameters

  • id (string) required
  • $body (object)

customerGroupManagementV1IsReadonlyGet

Check if customer group can be deleted.

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

Parameters

  • id (integer) required

customerAccountManagementV1CreateAccountPost

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

t213_vg.customerAccountManagementV1CreateAccountPost({}, context)

Parameters

  • $body (object)

customerAddressRepositoryV1GetByIdGet

Retrieve customer address.

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

Parameters

  • addressId (integer) required

customerAccountManagementV1ResendConfirmationPost

Resend confirmation email.

t213_vg.customerAccountManagementV1ResendConfirmationPost({}, context)

Parameters

  • $body (object)

customerAccountManagementV1IsEmailAvailablePost

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

t213_vg.customerAccountManagementV1IsEmailAvailablePost({}, context)

Parameters

  • $body (object)

V1.customers.me.get

Get customer by customer ID.

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

V1.customers.me.put

Create or update a customer.

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

Parameters

  • $body (object)

customerAccountManagementV1ActivateByIdPut

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

t213_vg.customerAccountManagementV1ActivateByIdPut({}, context)

Parameters

  • $body (object)

V1.customers.me.billingAddress.get

Retrieve default billing address for the given customerId.

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

customerAccountManagementV1ChangePasswordByIdPut

Change customer password.

t213_vg.customerAccountManagementV1ChangePasswordByIdPut({}, context)

Parameters

  • $body (object)

V1.customers.me.shippingAddress.get

Retrieve default shipping address for the given customerId.

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

customerAccountManagementV1InitiatePasswordResetPut

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

t213_vg.customerAccountManagementV1InitiatePasswordResetPut({}, context)

Parameters

  • $body (object)

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.

t213_vg.customerCustomerRepositoryV1GetListGet({}, context)

Parameters

customerAccountManagementV1ValidatePut

Validate customer data.

t213_vg.customerAccountManagementV1ValidatePut({}, context)

Parameters

  • $body (object)

customerCustomerRepositoryV1DeleteByIdDelete

Delete customer by ID.

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

Parameters

  • customerId (integer) required

V1.customers.customerId.get

Get customer by customer ID.

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

Parameters

  • customerId (integer) required

V1.customers.customerId.billingAddress.get

Retrieve default billing address for the given customerId.

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

Parameters

  • customerId (integer) required

V1.customers.customerId.carts.post

Creates an empty cart and quote for a specified customer.

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

Parameters

  • customerId (integer) required - The customer ID.

customerAccountManagementV1GetConfirmationStatusGet

Gets the account confirmation status.

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

Parameters

  • customerId (integer) required

customerAccountManagementV1ValidateResetPasswordLinkTokenGet

Check if password reset token is valid.

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

Parameters

  • customerId (integer) required
  • resetPasswordLinkToken (string) required

customerAccountManagementV1IsReadonlyGet

Check if customer can be deleted.

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

Parameters

  • customerId (integer) required

V1.customers.customerId.shippingAddress.get

Retrieve default shipping address for the given customerId.

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

Parameters

  • customerId (integer) required

customerAccountManagementV1ActivatePut

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

t213_vg.customerAccountManagementV1ActivatePut({
  "email": ""
}, context)

Parameters

  • email (string) required
  • $body (object)

V1.customers.id.put

Create or update a customer.

t213_vg.V1.customers.id.put({
  "id": ""
}, context)

Parameters

  • id (string) required
  • $body (object)

directoryCountryInformationAcquirerV1GetCountriesInfoGet

Get all countries and regions information for the store.

t213_vg.directoryCountryInformationAcquirerV1GetCountriesInfoGet(null, context)

directoryCountryInformationAcquirerV1GetCountryInfoGet

Get country and region information for the store.

t213_vg.directoryCountryInformationAcquirerV1GetCountryInfoGet({
  "countryId": ""
}, context)

Parameters

  • countryId (string) required

directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet

Get currency information for the store.

t213_vg.directoryCurrencyInformationAcquirerV1GetCurrencyInfoGet(null, context)

eavAttributeSetManagementV1CreatePost

Create attribute set from data

t213_vg.eavAttributeSetManagementV1CreatePost({}, context)

Parameters

  • $body (object)

eavAttributeSetRepositoryV1GetListGet

Retrieve list of Attribute Sets 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#AttributeSetRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

t213_vg.eavAttributeSetRepositoryV1GetListGet({}, context)

Parameters

eavAttributeSetRepositoryV1DeleteByIdDelete

Remove attribute set by given ID

t213_vg.eavAttributeSetRepositoryV1DeleteByIdDelete({
  "attributeSetId": 0
}, context)

Parameters

  • attributeSetId (integer) required

eavAttributeSetRepositoryV1GetGet

Retrieve attribute set information based on given ID

t213_vg.eavAttributeSetRepositoryV1GetGet({
  "attributeSetId": 0
}, context)

Parameters

  • attributeSetId (integer) required

eavAttributeSetRepositoryV1SavePut

Save attribute set data

t213_vg.eavAttributeSetRepositoryV1SavePut({
  "attributeSetId": ""
}, context)

Parameters

  • attributeSetId (string) required
  • $body (object)

giftWrappingWrappingRepositoryV1GetListGet

Return list of gift wrapping data objects based on search criteria

t213_vg.giftWrappingWrappingRepositoryV1GetListGet({}, context)

Parameters

giftWrappingWrappingRepositoryV1SavePost

Create/Update new gift wrapping with data object values

t213_vg.giftWrappingWrappingRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

giftWrappingWrappingRepositoryV1DeleteByIdDelete

Delete gift wrapping

t213_vg.giftWrappingWrappingRepositoryV1DeleteByIdDelete({
  "id": 0
}, context)

Parameters

  • id (integer) required

giftWrappingWrappingRepositoryV1GetGet

Return data object for specified wrapping ID and store.

t213_vg.giftWrappingWrappingRepositoryV1GetGet({
  "id": 0
}, context)

Parameters

  • id (integer) required
  • storeId (integer)

giftWrappingWrappingRepositoryV1SavePut

Create/Update new gift wrapping with data object values

t213_vg.giftWrappingWrappingRepositoryV1SavePut({
  "wrappingId": ""
}, context)

Parameters

  • wrappingId (string) required
  • $body (object)

giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost

Estimate shipping

t213_vg.giftRegistryShippingMethodManagementV1EstimateByRegistryIdPost({}, context)

Parameters

  • $body (object)

quoteGuestCartManagementV1CreateEmptyCartPost

Enable an customer or guest user to create an empty cart and quote for an anonymous customer.

t213_vg.quoteGuestCartManagementV1CreateEmptyCartPost(null, context)

quoteGuestCartRepositoryV1GetGet

Enable a guest user to return information for a specified cart.

t213_vg.quoteGuestCartRepositoryV1GetGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required

quoteGuestCartManagementV1AssignCustomerPut

Assign a specified customer to a specified shopping cart.

t213_vg.quoteGuestCartManagementV1AssignCustomerPut({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • $body (object)

quoteGuestBillingAddressManagementV1GetGet

Return the billing address for a specified quote.

t213_vg.quoteGuestBillingAddressManagementV1GetGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.

quoteGuestBillingAddressManagementV1AssignPost

Assign a specified billing address to a specified cart.

t213_vg.quoteGuestBillingAddressManagementV1AssignPost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • $body (object)

quoteGuestCartTotalManagementV1CollectTotalsPut

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

t213_vg.quoteGuestCartTotalManagementV1CollectTotalsPut({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • $body (object)

quoteGuestCouponManagementV1RemoveDelete

Delete a coupon from a specified cart.

t213_vg.quoteGuestCouponManagementV1RemoveDelete({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.

quoteGuestCouponManagementV1GetGet

Return information for a coupon in a specified cart.

t213_vg.quoteGuestCouponManagementV1GetGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.

quoteGuestCouponManagementV1SetPut

Add a coupon by code to a specified cart.

t213_vg.quoteGuestCouponManagementV1SetPut({
  "cartId": "",
  "couponCode": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • couponCode (string) required - The coupon code data.

quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost

Estimate shipping by address and return list of available shipping methods

t213_vg.quoteGuestShipmentEstimationV1EstimateByExtendedAddressPost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required
  • $body (object)

giftMessageGuestCartRepositoryV1GetGet

Return the gift message for a specified order.

t213_vg.giftMessageGuestCartRepositoryV1GetGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The shopping cart ID.

giftMessageGuestCartRepositoryV1SavePost

Set the gift message for an entire order.

t213_vg.giftMessageGuestCartRepositoryV1SavePost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • $body (object)

giftMessageGuestItemRepositoryV1GetGet

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

t213_vg.giftMessageGuestItemRepositoryV1GetGet({
  "cartId": "",
  "itemId": 0
}, context)

Parameters

  • cartId (string) required - The shopping cart ID.
  • itemId (integer) required - The item ID.

giftMessageGuestItemRepositoryV1SavePost

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

t213_vg.giftMessageGuestItemRepositoryV1SavePost({
  "cartId": "",
  "itemId": 0
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • itemId (integer) required - The item ID.
  • $body (object)

quoteGuestCartItemRepositoryV1GetListGet

List items that are assigned to a specified cart.

t213_vg.quoteGuestCartItemRepositoryV1GetListGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.

quoteGuestCartItemRepositoryV1SavePost

Add the specified item to the specified cart.

t213_vg.quoteGuestCartItemRepositoryV1SavePost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required
  • $body (object)

quoteGuestCartItemRepositoryV1DeleteByIdDelete

Remove the specified item from the specified cart.

t213_vg.quoteGuestCartItemRepositoryV1DeleteByIdDelete({
  "cartId": "",
  "itemId": 0
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • itemId (integer) required - The item ID of the item to be removed.

quoteGuestCartItemRepositoryV1SavePut

Add the specified item to the specified cart.

t213_vg.quoteGuestCartItemRepositoryV1SavePut({
  "cartId": "",
  "itemId": ""
}, context)

Parameters

  • cartId (string) required
  • itemId (string) required
  • $body (object)

quoteGuestCartManagementV1PlaceOrderPut

Place an order for a specified cart.

t213_vg.quoteGuestCartManagementV1PlaceOrderPut({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • $body (object)

checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet

Get payment information

t213_vg.checkoutGuestPaymentInformationManagementV1GetPaymentInformationGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required

checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost

Set payment information and place order for a specified cart.

t213_vg.checkoutGuestPaymentInformationManagementV1SavePaymentInformationAndPlaceOrderPost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required
  • $body (object)

quoteGuestPaymentMethodManagementV1GetListGet

List 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#GuestPaymentMethodManagementInterface to determine which call to use to get detailed information about all attributes for an object.

t213_vg.quoteGuestPaymentMethodManagementV1GetListGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.

quoteGuestPaymentMethodManagementV1GetGet

Return the payment method for a specified shopping cart.

t213_vg.quoteGuestPaymentMethodManagementV1GetGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.

quoteGuestPaymentMethodManagementV1SetPut

Add a specified payment method to a specified shopping cart.

t213_vg.quoteGuestPaymentMethodManagementV1SetPut({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.
  • $body (object)

checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost

Set payment information for a specified cart.

t213_vg.checkoutGuestPaymentInformationManagementV1SavePaymentInformationPost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required
  • $body (object)

checkoutGuestShippingInformationManagementV1SaveAddressInformationPost

t213_vg.checkoutGuestShippingInformationManagementV1SaveAddressInformationPost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required
  • $body (object)

quoteGuestShippingMethodManagementV1GetListGet

List applicable shipping methods for a specified quote.

t213_vg.quoteGuestShippingMethodManagementV1GetListGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The shopping cart ID.

quoteGuestCartTotalRepositoryV1GetGet

Return quote totals data for a specified cart.

t213_vg.quoteGuestCartTotalRepositoryV1GetGet({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The cart ID.

checkoutGuestTotalsInformationManagementV1CalculatePost

Calculate quote totals based on address and shipping method.

t213_vg.checkoutGuestTotalsInformationManagementV1CalculatePost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required
  • $body (object)

giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost

Estimate shipping

t213_vg.giftRegistryGuestCartShippingMethodManagementV1EstimateByRegistryIdPost({
  "cartId": ""
}, context)

Parameters

  • cartId (string) required - The shopping cart ID.
  • $body (object)

integrationAdminTokenServiceV1CreateAdminAccessTokenPost

Create access token for admin given the admin credentials.

t213_vg.integrationAdminTokenServiceV1CreateAdminAccessTokenPost({}, context)

Parameters

  • $body (object)

integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost

Create access token for admin given the customer credentials.

t213_vg.integrationCustomerTokenServiceV1CreateCustomerAccessTokenPost({}, context)

Parameters

  • $body (object)

salesRefundInvoiceV1ExecutePost

Create refund for invoice

t213_vg.salesRefundInvoiceV1ExecutePost({
  "invoiceId": 0
}, context)

Parameters

  • invoiceId (integer) required
  • $body (object)

salesInvoiceRepositoryV1GetListGet

Lists invoices 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#InvoiceRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

t213_vg.salesInvoiceRepositoryV1GetListGet({}, context)

Parameters

salesInvoiceRepositoryV1SavePost

Performs persist operations for a specified invoice.

t213_vg.salesInvoiceRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

salesInvoiceCommentRepositoryV1SavePost

Performs persist operations for a specified invoice comment.

t213_vg.salesInvoiceCommentRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

salesInvoiceRepositoryV1GetGet

Loads a specified invoice.

t213_vg.salesInvoiceRepositoryV1GetGet({
  "id": 0
}, context)

Parameters

  • id (integer) required - The invoice ID.

salesInvoiceManagementV1SetCapturePost

Sets invoice capture.

t213_vg.salesInvoiceManagementV1SetCapturePost({
  "id": 0
}, context)

Parameters

  • id (integer) required

salesInvoiceManagementV1GetCommentsListGet

Lists comments for a specified invoice.

t213_vg.salesInvoiceManagementV1GetCommentsListGet({
  "id": 0
}, context)

Parameters

  • id (integer) required - The invoice ID.

salesInvoiceManagementV1NotifyPost

Emails a user a specified invoice.

t213_vg.salesInvoiceManagementV1NotifyPost({
  "id": 0
}, context)

Parameters

  • id (integer) required - The invoice ID.

salesInvoiceManagementV1SetVoidPost

Voids a specified invoice.

t213_vg.salesInvoiceManagementV1SetVoidPost({
  "id": 0
}, context)

Parameters

  • id (integer) required - The invoice ID.

backendModuleServiceV1GetModulesGet

Returns an array of enabled modules

t213_vg.backendModuleServiceV1GetModulesGet(null, context)

salesInvoiceOrderV1ExecutePost

t213_vg.salesInvoiceOrderV1ExecutePost({
  "orderId": 0
}, context)

Parameters

  • orderId (integer) required
  • $body (object)

salesRefundOrderV1ExecutePost

Create offline refund for order

t213_vg.salesRefundOrderV1ExecutePost({
  "orderId": 0
}, context)

Parameters

  • orderId (integer) required
  • $body (object)

salesShipOrderV1ExecutePost

Creates new Shipment for given Order.

t213_vg.salesShipOrderV1ExecutePost({
  "orderId": 0
}, context)

Parameters

  • orderId (integer) required
  • $body (object)

salesOrderRepositoryV1GetListGet

Lists orders 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#OrderRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

t213_vg.salesOrderRepositoryV1GetListGet({}, context)

Parameters

salesOrderRepositoryV1SavePost

Performs persist operations for a specified order.

t213_vg.salesOrderRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

salesOrderRepositoryV1SavePut

Performs persist operations for a specified order.

t213_vg.salesOrderRepositoryV1SavePut({}, context)

Parameters

  • $body (object)

salesOrderItemRepositoryV1GetListGet

Lists order items 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#OrderItemRepositoryInterface to determine which call to use to get detailed information about all attributes for an object.

t213_vg.salesOrderItemRepositoryV1GetListGet({}, context)

Parameters

salesOrderItemRepositoryV1GetGet

Loads a specified order item.

t213_vg.salesOrderItemRepositoryV1GetGet({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order item ID.

salesOrderRepositoryV1GetGet

Loads a specified order.

t213_vg.salesOrderRepositoryV1GetGet({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.

salesOrderManagementV1CancelPost

Cancels a specified order.

t213_vg.salesOrderManagementV1CancelPost({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.

salesOrderManagementV1GetCommentsListGet

Lists comments for a specified order.

t213_vg.salesOrderManagementV1GetCommentsListGet({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.

salesOrderManagementV1AddCommentPost

Adds a comment to a specified order.

t213_vg.salesOrderManagementV1AddCommentPost({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.
  • $body (object)

salesOrderManagementV1NotifyPost

Emails a user a specified order.

t213_vg.salesOrderManagementV1NotifyPost({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.

salesOrderManagementV1HoldPost

Holds a specified order.

t213_vg.salesOrderManagementV1HoldPost({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.

salesOrderManagementV1GetStatusGet

Gets the status for a specified order.

t213_vg.salesOrderManagementV1GetStatusGet({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.

salesOrderManagementV1UnHoldPost

Releases a specified order from hold status.

t213_vg.salesOrderManagementV1UnHoldPost({
  "id": 0
}, context)

Parameters

  • id (integer) required - The order ID.

salesOrderAddressRepositoryV1SavePut

Performs persist operations for a specified order address.

t213_vg.salesOrderAddressRepositoryV1SavePut({
  "parent_id": ""
}, context)

Parameters

  • parent_id (string) required
  • $body (object)

catalogProductRepositoryV1GetListGet

Get product list

t213_vg.catalogProductRepositoryV1GetListGet({}, context)

Parameters

catalogProductRepositoryV1SavePost

Create product

t213_vg.catalogProductRepositoryV1SavePost({}, context)

Parameters

  • $body (object)

catalogAttributeSetManagementV1CreatePost

Create attribute set from data

t213_vg.catalogAttributeSetManagementV1CreatePost({}, context)

Parameters

  • $body (object)

catalogProductAttributeManagementV1AssignPost

Assign attribute to attribute set

t213_vg.catalogProductAttributeManagementV1AssignPost({}, context)

Parameters

  • $body (object)

catalogProductAttributeGroup