Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 9b53c46

Browse files
keharperkeharper
authored
Merge pull request #8414 from RakeshJesadiya/b2b-webapi-update
add purchase order changes
2 parents 9800059 + 59bf1dc commit 9b53c46

File tree

3 files changed

+222
-2
lines changed

3 files changed

+222
-2
lines changed

‎src/guides/v2.3/b2b/bk-b2b.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ ConfigurableSharedCatalog |Enables configurable products to be added to a shared
4646
GiftCardNegotiableQuote | Enables gift cards to be displayed in a negotiable quote in an B2B environment | No
4747
GiftCardRequisitionList | Enables gift cards to be displayed in a requisition list | No
4848
GiftCardSharedCatalog | Enables gift cards to be added to a shared catalog in an B2B environment. | No
49+
GroupedRequisitionList | Enables grouped products to be displayed in a requisition list | No
4950
GroupedSharedCatalog | Enables grouped products to be added to a shared catalog in an B2B environment. | No
5051
NegotiableQuote | Allows a buyer and a seller (admin user) to negotiate product and/or shipping prices before the buyer places an order. | Yes
5152
NegotiableQuoteSharedCatalog | Enables the `NegotiableQuote` module to interact with a `SharedCatalog` in an B2B environment. | No

‎src/guides/v2.4/b2b/bk-b2b.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎src/guides/v2.4/b2b/bk-b2b.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
group: b2b-developer-guide
3+
subgroup: 01_Introduction
4+
title: B2B Developer Guide
5+
landing-page: B2B
6+
menu_title: B2B Developer Guide
7+
menu_order: 1
8+
menu_node: parent
9+
ee_only: True
10+
functional_areas:
11+
- B2B
12+
- Integration
13+
---
14+
15+
Unlike the standard business-to-consumer model, {{site.data.var.b2b}} (Business to Business) is designed to meet the needs of sellers (Magento merchants) whose customers are primarily companies—possibly with complex organizational structures and multiple users with various roles and levels of permission.
16+
17+
There are two basic actors in B2B model:
18+
19+
* A **seller** is an admin user that accesses the system from the Magento Admin panel.
20+
* A **buyer** is any customer associated with a company account who accesses the system from the storefront.
21+
22+
The Company component is the key entity within B2B on which all other features are in some way dependent. It allows joining multiple buyers that belong to the same company into a single company account (or corporate account). The company admin is able to build the company structure (divisions, subdivisions and users) in the appropriate hierarchy and provide different user roles and permissions to the company members. Such a hierarchy allows the company admin to control user activity within an account: ordering, quoting, purchasing, access to company credit info or profile, etc. In addition, a seller can configure how the buying company operates at the website: including the payment methods, pricing levels, the ability to negotiate over prices, and the ability to create requisition lists.
23+
24+
Companies have an option to Pay on Account, or in other words make purchases in credit. The seller allocates credit for a company account and manages credit settings for a company as well as credit reimbursement.
25+
26+
Shared catalogs are the pricing levels that allow setting custom prices per product for different companies on one or multiple websites. By using shared catalogs, a seller can sell this product by applying different pricing levels for different customer groups.
27+
28+
The seller and a buyer representing a company can negotiate the price of an order prior to order placement. This functionality is supported by the Negotiable Quote module. It means that before making an order, the buyer can initiate negotiations with the seller on prices and discounts. Negotiations suggest that the created quote may be submitted, reviewed and modified several times before it is converted into an order.
29+
30+
## B2B Modules
31+
32+
{{site.data.var.b2b}} is a set of modules that are installed on top of {{site.data.var.ee}}. The following table lists the modules provided with B2B.
33+
34+
Name | Description | WebAPI enabled?
35+
--- | --- | ---
36+
B2b | The base module for B2B. It also provides branding elements. | No
37+
BundleNegotiableQuote | Enables bundle products to be displayed in a negotiable quote in an B2B environment | No
38+
BundleRequisitionList | Enables bundle products to be displayed in a requisition list | No
39+
BundleSharedCatalog | Enables bundle products to be added to a shared catalog in an B2B environment. | No
40+
Company | Allows a seller to create a company account and assign multiple members of the company to the account. | Yes
41+
CompanyCredit | Adds the Payment on Account payment method for B2B companies. | Yes
42+
CompanyPayment | Allows a seller to configure which payment methods are available for B2B companies. | No
43+
ConfigurableNegotiableQuote | Enables configurable products to be displayed in a negotiable quote in an B2B environment | No
44+
ConfigurableRequisitionList | Enables configurable products to be displayed in a requisition list | No
45+
ConfigurableSharedCatalog |Enables configurable products to be added to a shared catalog in an B2B environment. | No
46+
GiftCardNegotiableQuote | Enables gift cards to be displayed in a negotiable quote in an B2B environment | No
47+
GiftCardRequisitionList | Enables gift cards to be displayed in a requisition list | No
48+
GiftCardSharedCatalog | Enables gift cards to be added to a shared catalog in an B2B environment. | No
49+
GroupedRequisitionList | Enables grouped products to be displayed in a requisition list | No
50+
GroupedSharedCatalog | Enables grouped products to be added to a shared catalog in an B2B environment. | No
51+
NegotiableQuote | Allows a buyer and a seller (admin user) to negotiate product and/or shipping prices before the buyer places an order. | Yes
52+
NegotiableQuoteSharedCatalog | Enables the `NegotiableQuote` module to interact with a `SharedCatalog` in an B2B environment. | No
53+
PurchaseOrder | Allows buyers and seller to create a purchase order. | Yes
54+
PurchaseOrderRule | Allows creating and enforcing approval rules for purchase orders. | No
55+
QuickOrder | Allows buyers to create a new order from a list of multiple SKUs. | No
56+
RequisitionList | Allows a buyer to create multiple lists of frequently-purchased items and use those lists for order placement. | No
57+
SharedCatalog | Defines the visibility of products and prices in the catalog and in B2B quotes for different company accounts. | Yes
58+
59+
## Related information
60+
61+
* [Install the B2B extension]({{ site.baseurl }}/extensions/b2b/)
62+
* [Getting started with {{site.data.var.b2b}}](http://docs.magento.com/m2/b2b/user_guide/getting-started.html)

‎src/guides/v2.4/b2b/integrations.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎src/guides/v2.4/b2b/integrations.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
---
2+
group: b2b-developer-guide
3+
subgroup: 10_REST
4+
title: Integrate with B2B using REST
5+
menu_title: Integrate with B2B using REST
6+
menu_order: 1
7+
menu_node: parent
8+
ee_only: True
9+
functional_areas:
10+
- B2B
11+
- Integration
12+
---
13+
14+
This topic lists the REST endpoints and services that are provided with {{site.data.var.b2b}}.
15+
16+
## List of REST endpoints by module
17+
18+
### Company
19+
20+
```terminal
21+
GET /V1/company/
22+
GET /V1/company/:companyId
23+
DELETE /V1/company/:companyId
24+
PUT /V1/company/:companyId
25+
POST /V1/company/
26+
GET /V1/team/
27+
GET /V1/team/:teamId
28+
DELETE /V1/team/:teamId
29+
PUT /V1/team/:teamId
30+
POST /V1/team/:companyId
31+
GET /V1/hierarchy/:id
32+
PUT /V1/hierarchy/move/:id
33+
GET /V1/company/role/
34+
GET /V1/company/role/:roleId
35+
POST /V1/company/role/
36+
DELETE /V1/company/role/:roleId
37+
PUT /V1/company/role/:id
38+
PUT /V1/company/assignRoles
39+
GET /V1/company/role/:roleId/users
40+
```
41+
42+
### CompanyCredit
43+
44+
```terminal
45+
GET /V1/companyCredits/
46+
GET /V1/companyCredits/:creditId
47+
PUT /V1/companyCredits/:id
48+
GET /V1/companyCredits/company/:companyId
49+
POST /V1/companyCredits/:creditId/increaseBalance
50+
POST /V1/companyCredits/:creditId/decreaseBalance
51+
GET /V1/companyCredits/history
52+
PUT /V1/companyCredits/history/:historyId
53+
```
54+
55+
### NegotiableQuote
56+
57+
```terminal
58+
POST /V1/negotiableQuote/request
59+
POST /V1/negotiableQuote/submitToCustomer
60+
POST /V1/negotiableQuote/decline
61+
POST /V1/negotiableQuote/pricesUpdated
62+
GET /V1/negotiableQuote/attachmentContent
63+
GET /V1/negotiableQuote/:quoteId/comments
64+
PUT /V1/negotiableQuote/:quoteId/shippingMethod
65+
POST /V1/negotiable-carts/:cartId/payment-information
66+
GET /V1/negotiable-carts/:cartId/payment-information
67+
POST /V1/negotiable-carts/:cartId/set-payment-information
68+
POST /V1/negotiable-carts/:cartId/shipping-information
69+
POST /V1/negotiable-carts/:cartId/estimate-shipping-methods
70+
POST /V1/negotiable-carts/:cartId/estimate-shipping-methods-by-address-id
71+
PUT /V1/negotiableQuote/:quoteId
72+
GET /V1/negotiable-carts/:cartId/billing-address
73+
POST /V1/negotiable-carts/:cartId/billing-address
74+
GET /V1/negotiable-carts/:cartId/totals
75+
PUT /V1/negotiable-carts/:cartId/coupons/:couponCode
76+
DELETE /V1/negotiable-carts/:cartId/coupons
77+
POST /V1/negotiable-carts/:cartId/giftCards
78+
DELETE /V1/negotiable-carts/:cartId/giftCards/:giftCardCode
79+
```
80+
81+
### PurchaseOrder
82+
83+
```terminal
84+
POST /V1/carts/mine/po-payment-information
85+
```
86+
87+
### SharedCatalog
88+
89+
```terminal
90+
GET /V1/sharedCatalog/:sharedCatalogId
91+
POST /V1/sharedCatalog
92+
PUT /V1/sharedCatalog/:id
93+
DELETE /V1/sharedCatalog/:sharedCatalogId
94+
GET /V1/sharedCatalog/
95+
GET /V1/sharedCatalog/:sharedCatalogId/companies
96+
POST /V1/sharedCatalog/:sharedCatalogId/assignCompanies
97+
POST /V1/sharedCatalog/:sharedCatalogId/unassignCompanies
98+
GET /V1/sharedCatalog/:id/products
99+
POST /V1/sharedCatalog/:id/assignProducts
100+
POST /V1/sharedCatalog/:id/unassignProducts
101+
GET /V1/sharedCatalog/:id/categories
102+
POST /V1/sharedCatalog/:id/assignCategories
103+
POST /V1/sharedCatalog/:id/unassignCategories
104+
```
105+
106+
## List of service names per Module
107+
108+
### Company
109+
110+
```terminal
111+
companyAclV1
112+
companyCompanyHierarchyV1
113+
companyCompanyRepositoryV1
114+
companyRoleRepositoryV1
115+
companyTeamRepositoryV1
116+
configurableProductConfigurableProductManagementV1
117+
```
118+
119+
### CompanyCredit
120+
121+
```terminal
122+
companyCreditCreditBalanceManagementV1
123+
companyCreditCreditHistoryManagementV1
124+
companyCreditCreditLimitManagementV1
125+
companyCreditCreditLimitRepositoryV1
126+
```
127+
128+
### NegotiableQuote
129+
130+
```terminal
131+
negotiableQuoteAttachmentContentManagementV1
132+
negotiableQuoteBillingAddressManagementV1
133+
negotiableQuoteCartTotalRepositoryV1
134+
negotiableQuoteCommentLocatorV1
135+
negotiableQuoteCouponManagementV1
136+
negotiableQuoteGiftCardAccountManagementV1
137+
negotiableQuoteNegotiableQuoteManagementV1
138+
negotiableQuoteNegotiableQuotePriceManagementV1
139+
negotiableQuoteNegotiableQuoteShippingManagementV1
140+
negotiableQuotePaymentInformationManagementV1
141+
negotiableQuoteShipmentEstimationV1
142+
negotiableQuoteShippingInformationManagementV1
143+
negotiableQuoteShippingMethodManagementV1
144+
```
145+
146+
### PurchaseOrder
147+
148+
```terminal
149+
purchaseOrderPurchaseOrderPaymentInformationManagementV1
150+
```
151+
152+
### SharedCatalog
153+
154+
```terminal
155+
sharedCatalogCategoryManagementV1
156+
sharedCatalogCompanyManagementV1
157+
sharedCatalogProductManagementV1
158+
sharedCatalogSharedCatalogRepositoryV1
159+
```

0 commit comments

Comments
 (0)