B2B Company Account API

B2B Company Account API

1. Amasty\CompanyAccount\Api\CompanyRepositoryInterface - class for managing company accounts.
  1. GET /V1/amcompany/company/:companyId, method="getById" - get information about the company by its ID;
  2. POST /V1/amcompany/company, method="save" - create a company account;
  3. PUT /V1/amcompany/company/:companyId, method="save" - edit a company account;
  4. DELETE /V1/amcompany/company/:companyId, method="deleteById" - delete a company account by its ID.

2. Amasty\CompanyAccount\Api\CreditRepositoryInterface - class for managing company credit balance.
  1. PUT /V1/amcompany/credit/:companyId, method="save" - update company account's store credits;
  2. GET /V1/amcompany/credit/:companyId - view company account's store credits

3. Amasty\CompanyAccount\Api\CustomerRepositoryInterface - class for managing users within company accounts.
  1. POST /V1/amcompany/customer/:companyId, method="assignToCompany" - add user to a company account;
  2. DELETE /V1/amcompany/customer/:customerId, method="delete" - delete user from a company account.
Since v. 2.6.2 we added the ability to fetch the list of all created companies via REST API. You can find the 'amasty/module-company-account-subscription-functionality' package for installing in composer suggest. Kindly note that the feature is available as a part of an active product subscription or support subscription.
     Amasty\CompanyAccount\Api\CompanyRepositoryInterface - class for managing the list of all created companies
  1.   GET /V1/amcompany/company/all, method="getList" - to get the list of all created companies.


      • Related Articles

      • What Amasty extensions support API?

        Each Amasty extension that has API support, includes the etc/webapi.xml file. The webapi.xml file contains API configurations with the list of available API requests. For example, a request from the Custom Form module interface: 1 - endpoint URL; 2 - ...

      • Gift Card API

        1. Amasty\GiftCard\Api\ImageRepositoryInterface - class for managing gift card images: POST /V1/amgcard/image, method="save" - save a gift card image; PUT /V1/amgcard/image/:id, method="save" - save a gift card image by ID; DELETE ...

      • One Step Checkout API

        1. Amasty\Checkout\Api\AdditionalFieldsManagementInterface - class for managing additional fields for logged-in users: POST /V1/amasty_checkout/carts/:cartId/amcheckoutFields, method="save" - save a field for a specific cart by ID; POST ...

      • Request a Quote API

        1. Amasty\RequestQuote\Api\RemarkServiceInterface: PUT /V1/amasty_quote/updateRemark, method="save" - add information to the Remark field. 2. Amasty\RequestQuote\Api\QuoteRepositoryInterface - class for managing quotes: PUT ...

      • Store Pickup API

        1. Amasty\StorePickup\Api\GuestShippingMethodManagementInterface - class for managing shipping methods on guest checkout: POST /V1/guest-carts/:cartId/estimate-shipping-methods, method="estimateByExtendedAddress" - displays available shipping methods ...