Managing Orders
You can see the order details of your orders after logging into Partner Commerce. My Orders page lists all the orders that you are working with for the selected account. You can also see the total order number and amount at the top of the My Orders page. The total order number and amount will change depending on the filter applied.
The following API with the appropriate parameters is used to retrieve the selected account's order data. For more information, click here.
GET https://<URL_of_the_Instance>/api/order/v1/orders
- View summary chart: You can view the summary chart for all of the orders that are placed. You can also customize the chart by applying the advanced filters. Orders by Status (bar chart) and Order Amount by Status (pie chart) charts are available with out-of-the-box template. Hovering the mouse over a status displays the quantity and amount for that status.
- Search for an order: You can search for the order to refine the order list. Enter a keyword related to the name. It displays all orders that contain that keyword.Note:
The following API with the filter parameter is used to search for the particular order. For more information, click here.
GET
https://<URL_of_the_Instance>/api/order/v1/ordersFor example:
https://<URL_of_the_Instance>/api/order/v1/orders?filter=eq(SoldToAccount.Id:'<soldtoaccountID>')&sort=DESC(ModifiedDate)&filter=LIKE(Name:'Test')&Page=1&limit=10 - Sort the order list: You can sort the order list by clicking the column names.
- Set pagination: You can specify how many orders should be displayed on a single page. To enable pagination, go to the per page field on the top right bar and select a value from 10, 20, 30, or 40 orders per page.
- Filter the order list: You can sort the order list by clicking the filter icon. The Advanced Filters pop-up appears. You can filter the order list based on the following fields. You can also add multiple filter criteria by clicking the Add Criteria button.
- Bill To
- Created Date
- Order Amount
- Status
The following API with the filter, page, limit, and sort parameters is used for sorting, pagination, and filtering. For more information, click here.
GET https://<URL_of_the_Instance>/api/order/v1/orders
For example:
https://<URL_of_the_Instance>/api/order/v1/orders?filter=eq(Status:'Draft')&filter=eq(SoldToAccount.Id:'<soldtoaccountID>')&sort=DESC(ModifiedDate)&Page=1&limit=10
From the My Orders page, you can:
As an experienced buyer, you can also use the Quick-Add () button to add multiple products to the cart and create quotes and orders quickly. For more information, see Using CTA (call-to-action) button.
Creating an Order
As a Partner Sales Representative or Order Desk User, you can create an order on behalf of a customer to help them in ordering products or services. you can add products to the cart and create an order quote by clicking the Place Order button on the cart page. The Create Order page appears.
To create an order
- Enter the following details for the order on the Create Orderpage; however, some of the fields have default values.
Field Name
Description
Sold To
Shows the name of the account associated with the primary contact. You cannot edit this field.
Price List
Shows the name of the price list associated with the account selected. You cannot edit this field.
Order Name
Enter the name of the order. By default, it is auto-populated as New Order.
Primary Contact
Search and select the Primary Contact associated with your account.
Bill To
Shows theBill To location of the account associated with the primary contact. You can search and select another value to update this field.
Ship To
Shows the Ship To location of the account associated with the primary contact. You can search and select another value to update this field.
- Click Place Order. If the implementor has enabled the CAPTCHA functionality, follow the next step.Note:
By default, CAPTCHA functionality is not enabled. The implementor must set the captchaSiteKey? parameter to the template (see the Configuring Templates topic) and add the captcha property (see the image below) with the Price Summary component while configuring the template. For more information on the Price Summary component, see SDK Reference > Components section > Price Summary component.
- Check the captcha checkbox labeled "I'm not a robot". Sometimes, you may need to solve a captcha puzzle after clicking the checkbox.
After successfully verifying the Captcha, a request for an order will be sent out, and you will see a success confirmation popup after the order has been generated.
To see more information about the order, click VIEW YOUR ORDER. This opens the Order details page.
The following API is used for creating an order. For more information, click here.
POST https://<URL_of_the_Instance>/api/cart/v1/carts/{cartId}/order
The following API with the includes parameter is used for reviewing the created order (on the Review Your Order button). For more information, click here.
GET https://<URL_of_the_Instance>/api/order/v1/orders/{orderId}?includes=items
Viewing and Modifying a Created Order
After creating an order, you can view and modify some of the fields. To view all the orders created by you and belonging to the same account, go to My Accounts > My Orders page.
Click the Order Name link from the Order list page or click the REVIEW YOUR ORDER button from the Create Order confirmation popup. The order page appears where you can view and update the following details:
Order Summary
You can update the Primary Contact, Description, Ship To Account, and Bill To Account fields.
The following API is used for updating the value. For more information, click here.
PATCH https://<URL_of_the_Instance>/api/order/v1/orders/{orderId}
Line Items
- Click the Edit button to edit the line items in a created order to add, clone, modify, and delete items.
- After the changes are done, click Confirm Changes.
You can also open the Product Details and Configuration by clicking the product name and wrench icon respectively.
Attachments
If you want to upload some required document(s) in a particular order, you can upload it from the Attachments section.
Prerequisites
The implementer must create an IsPrivate custom field with a Boolean data type and default value as false on
the DocumentMetadata object. Use the Admin User Interface or the following API
and sample payload: POST
https://<URL_of_the_Instance>/api/schema/v1/objects/{objectName}/fields
{
"FieldName": "IsPrivate",
"DisplayName": "IsPrivate",
"DataType": "Boolean",
"DefaultValue": "false"
}
- From the order details page, click the Attachments tab.
- Drag and drop the file or click the browse link and select the file.
Refer to the following image for the supported file type.
- Check the Make visibility private checkbox to make the attachment only visible to you on the order details page.
- Click Clear if you want to remove the selected file.
- Click Upload to upload the selected file to the order.
You can File Name, Size, Type, Created By, and Created Date information under the Attachments section. The file types listed in the following image are supported. You can upload up to 28 MB of document(s).
The following API is used for uploading the document. For more information, click here.
POST https://<URL_of_the_Instance>/api/document-management/v1/documents/upload
For example: https://<URL_of_the_Instance>/api/document-management/v1/documents/upload?objectType=order&objectId={objectID}
You can only modify the line items when the order is in the Draft stage.
Generating an Order
As a partner, when you place an order on behalf of a customer, you must generate the order document before confirming the order. You can generate an order that is in Draft status.
To generate an order document
The order stage moves from Draft to Generated, the generated order document is available under the Attachments section, and a notification email is sent to the associated partner and customer. You can also download and delete the generated document.
The following API is used for the email notification. For more information, click here.
POST https://<URL_of_the_Instance>/api/email/v1/emails/bulk
Presenting an Order
In the Partner Commerce application, presenting an order allows partner users to share the order with customers. Once the order is in the Generated stage, the Present button is available. This enables partners to review and send the order to customers, ensuring they receive accurate pricing and details before making a decision.
For Generating an Order, see Generating an Order.
- Open the generated order details page, click Present.Documents and Send sections appear.Note:
The Documents and Send sections help you manage and send documents with the order.
- Documents Section: Allows you to choose documents related to the order.
- Send Section: Allows you to enter email details, select recipients, and add attachments to send the order via email.
- Use the Search documents box to find specific documents. Selected documents appear in the right panel.
- Click Next to proceed to the Send section. If you wish to discard your changes and go back to the order details page, click Discard.
- In the Review and Send, the To field is pre-filled with the order's primary contact email. You can change or add another email address by entering the recipient's email and selecting it from the list.
- You can add additional supporting documents for the order. Click Add Attachment to include additional supporting documents.
- In the Upload Files popup, you can drag and drop files or click browse to select them.
- To restrict visibility, check the Make visibility private box. To remove a file, click the delete icon next to the respective selected file.
- In the Upload Files popup, you can drag and drop files or click browse to select them.
- Click Confirm to add the attachment.The attachment appears on the main screen. To remove the attachment, click the delete icon next to it.
- Click Send to email the order details with the selected documents.
The system sends the email to the recipients with the order details and the selected documents as attachments.
Confirming an Order
As a partner, when a customer places an order or you place an order on behalf of a customer, you must confirm it to sync it with the cart and create the order line items. You can confirm an order that is in Draft or Generated status.
To confirm an order
The following API is used for confirming the order. For more information, click here.
POST https://<URL_of_the_Instance>/api/order/v1/orders/{orderId}/confirm
When an order is confirmed it is automatically generated and presented and the order status changes from Draft to Confirmed. After confirmation is complete, the user also receives an email notification.
