Fulfilment Options Page

Home
Essential Knowledge
By Type
Building Blocks
APIs
Releases

Essential knowledge

Author:

Fluent Commerce

Changed on:

6 May 2024

Overview

Fulfilment Options page
Further Reading

Key points

Fulfilment Options page
Further Reading

Fulfilment Options page

The fulfilment Options page displays the list of existing fulfilment options.

The Mystique SDK filter component searches for and views fulfilment option details. The Filter component performs the search based on the following filtering criterion:

(Fulfilment Option) Ref
Created On
Updated On

Fulfillment Options table displays information in the following columns:

Link:
```
`View`
```
, a link to go to the Fulfillment Option Details page
(Fulfillment Option) Ref: Unique reference of the fulfilment option
Status: Status of the fulfilment option
Order Type: Type of order – e.g., click and collect (CC) or home delivery (HD)
Type: Fulfilment Option Type
Creation Date: the Date and time when the fulfilment option was created

Fulfillment Option Details page

The Fulfillment Option Details page displays detailed information about the particular fulfilment option.

The detail view consists of the following tabs:

Details
Activity

Breadcrumbs

Back to Fulfillment Options:
```
`Link`
```
navigating back to the Fulfillment Options page

Details Tab

The details tab provides a detailed overview of the selected fulfilment option and is made up of the following:

Details card
Collection / Delivery Address card
Fulfillments Plans table
Products table

DETAILS CARD

the Details card contains the following information:

ID: Unique ID of a fulfilment option
Ref: Unique reference of a fulfilment option
Status: Status of a fulfilment option
Type: Fulfilment option type
Retailer ID: Unique ID of the retailer
Order Type: Type of order – e.g., click and collect (CC) or home delivery (HD)
Tracking Code: Tracking ID. A unique identifier for the end-user to link related Fulfillment options
Creation Date: the Date and time when the fulfilment option was created

COLLECTION/DELIVERY ADDRESS CARD

The Collection/Delivery Address card contains the following information:

Pickup Location Ref: The unique reference of the location. Mandatory for CC order type
Name: The contact name provided with the order
Company Name: The company name if delivering to a business location
Address 1: Street address
Address 2: Street address
City: City
State: State
Postcode: Postcode
Country: Country

FULFILLMENT PLANS TABLE

Fulfillment Plans table displays information in the following columns:

Link:
```
`View Plan`
```
,
ID: The unique ID of the fulfilment plan
Status: The status of the fulfilment plan
Type: The type of the fulfilment plan
Splits: The number of times this order was split

`View Plan`

is a link to go to the details page of a fulfilment plan.

PRODUCTS TABLE

The Products table displays information in the following columns:

Product Ref: SKU Reference of the requested item
Requested Quantity: Requested Quantity of the item
Catalogue Ref: The unique reference of a product catalogue

Activity tab

The Activity Tab displays all historical activities that have occurred during the lifecycle of the fulfilment option.

Fulfillment Plan details page

The fulfilment Plan details page displays detailed information about a particular fulfilment plan.

Layout

Breadcrumbs

Back to Fulfillment Option: Navigate to the Fulfillment Option Details page.

Summary card

The summary card contains the following information:

ID: The unique ID of the fulfilment plan
Ref: The unique reference of a fulfilment plan
Status: The status of a fulfilment plan
Creation Date: The Date and time when the fulfillment plan was created

Details Card

The Details card contains the following information:

ETA: The estimated time of completing the fulfilment. The ETA is configurable per retailer and can be in hours, e.g. “3HR” or days, e.g. “2D”
Type: Type of the Fulfillment Plan
Split Count: The number of items in the order was split

Fulfillments table

The Fulfillments table displays information in the following columns:

Location Ref: The unique reference of the location.
ETA: The estimated time of completing the fulfilment. The ETA is configurable per retailer and can be in hours, e.g. “3HR” or days, e.g. “2D”.
Fulfillment Type: Fulfillment type confirms how the customer will receive the order - in-store collection (CC) or delivery (HD) - and is used to determine the location(s) that can be used to pick and pack the order. The possible values are:
- CC_PFS: Click & Collect - Pick from Store
- CC_PFDC: Click & Collect - Pick from DC
- HD_PFS: Home Delivery - Pick from Store
- HD_PFDC: Home Delivery - Pick from DC
Items: The order item reference provided by the retailer
Requested: Requested Quantity of the item
Available: Available quantity of the item

Attributes table

Attributes table displays all attributes associated with the selected object and contains:

Name: Displays the name of the attribute associated with the selected object
Type: Displays the type of attribute associated with the selected object
Value: Displays the value of the attribute

The paging control is placed at the bottom of the tables. It includes the following:

Label “Rows per page” and a dropdown list right to the label, which is populated with the values: 10, 25, 100 (100 is selected by default);
Label in the format: Showing - ;
“<” and “>” icons to navigate to the previous/next pages;
“<” / “>” icon should be disabled if a user is on the first/last page respectively;
Pagination should be displayed if more than a set number of entries are available. If there are no entries at all or the number of entries is less than the set number of entries - pagination should not be visible.