B2B Contracts API
The B2B Contracts API allows you to create, retrieve, update, and delete contract documents stored in the CL data entity.
This feature is only available for stores using B2B Buyer Portal, which is currently available to select accounts.
When creating or updating contracts you must send each field according to the specifications provided. Otherwise, the Checkout module will not be able to autofill data during the shopping flow, which can block the purchase. Learn more about SmartCheckout - Customer information automatic fill-in.
Endpoints
Contracts
| Summary | Method | Path |
|---|---|---|
| Create contract | POST | /api/dataentities/CL/documents |
| Get contract by ID | GET | /api/dataentities/CL/documents/{contractId} |
| Update contract by ID | PATCH | /api/dataentities/CL/documents/{contractId} |
| Delete contract by ID | DELETE | /api/dataentities/CL/documents/{contractId} |